NAV
Shell HTTP JavaScript Ruby Python PHP Java Go

Dash Cards API v3.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Dash Cards API has multiple resources for cards, cardholders, orders, registrations, loads/unloads, programs, and funding management. These APIs allow users to create, search, retrieve, and update card. Please note that authorization tokens are required to access the Dash Card APIs. Learn how to generate Authorization tokens here.

Base URLs:

Cards

The Cards resource signifies a user bank account through which users can transact. Users can create, register, load/unload, fund, issue, close, and suspend cards. The different endpoints available in this resource are - GET/cards POST/cards/{identifier}/encrypt-for-vde GET/cards/{identifier}/token POST/cards/{identifier}/wallet-provisioned GET/cards/{identifier} GET/cards/{identifier}/resync POST/cards/{identifier}/replace POST/cards/{identifier}/reissue POST/cards/{identifier}/transfer POST /cards/{identifier}/activate POST/cards/{identifier}/close POST/cards/{identifier}/suspend POST/cards/{identifier}/unsuspend POST/cards/{identifier}/unmarkfraud and POST/cards/{identifier}/pin.

Learn more

Get Cards

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cards \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cards HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cards',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cards', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cards', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cards

Gets Cards in bulk. The details fetched are based on the token and optional parameters. This endpoint allows users to retrieve details about Cards, such as - card identifier, status, balance, expiration date, and more.

Parameters

Name In Type Required Description
max query integer false Maximum number of Card records to return. If unspecified, 50 records are returned by default.
token query string false A continuation token for pagination
customerIdentifier query string false Unique reference to identify a Customer
programIdentifier query string false Unique reference to identify a Program
orderIdentifier query string false Unique reference to identify an Order
externalIdentifier query string false External identifier supplied on creating a card used to identify a card.

Example responses

200 Response

{
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "externalIdentifier": "string",
      "isRefreshing": true,
      "proxyNumber": "string",
      "status": "Active",
      "balance": 0,
      "isProvisionedToWallet": true,
      "provisionedDate": "2019-08-24T14:15:22Z",
      "cardNumberLastFour": "string",
      "expiration": "2019-08-24T14:15:22Z",
      "creationDate": "2019-08-24T14:15:22Z",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "deepLink": "string",
      "tinyUrl": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "cardholder": {
        "firstName": "Maria",
        "lastName": "Wang",
        "email": "[email protected]",
        "phone": "5555550100",
        "dateOfBirth": "2000-01-01",
        "ssnLastFour": "string",
        "relation": "string",
        "other": "string",
        "billingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "mailingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ],
  "correlationId": "string"
}

Responses

Status Meaning Description Schema
200 OK Card get details cards
400 Bad Request Standard error response errors

Encrypt Card for Visa Digital Enablement

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "nonce": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/encrypt-for-vde", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/encrypt-for-vde

Encrypts card information. This endpoint encrypts critical data for the Visa Digital Enablement SDK based on cryptographic nonce.

Body parameter

{
  "nonce": "string"
}

Parameters

Name In Type Required Description
identifier path string true Identifies the card to encrypt
body body object true Encryption details
» nonce body string false An arbitrary number that can be used just once in a cryptographic communication.

Example responses

201 Response

{
  "encryptedPayload": "string"
}

Responses

Status Meaning Description Schema
201 Created Encrypted object result encryptedPayload

Create Temporary Token for a Card

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cards/{identifier}/token

Generates a temporary token that identifies the Card. This endpoint allows users to generate a temporary token that can be used to share card information in less secure environments.

Parameters

Name In Type Required Description
identifier path string true Unique identifier that identifies the Card

Example responses

201 Response

{
  "token": "string",
  "correlationId": "string"
}

Responses

Status Meaning Description Schema
201 Created Temporary token temporaryToken

Flag Card as Wallet Provisioned

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/wallet-provisioned", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/wallet-provisioned

Flags the card as provisioned to a mobile wallet. This endpoint enables card transactions via mobile wallet app if mobile wallet is provisioned for this user.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
201 Created User is provisioned to mobile wallet successfully. None

Get Card Details by identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cards/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cards/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cards/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cards/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cards/{identifier}

Gets Card details based on the parameter passed. The parameter could be an identifier, proxy or a token. This endpoint returns information about the card and cardholder.

Parameters

Name In Type Required Description
identifier path string true Identifies a card
byToken query boolean false Retrieves the card details based on the authorization token
byProxy query boolean false Retrieves the card details based on the proxy
programIdentifier query string false The program the proxy is associated with; Required if byProxy is true
isDigital query boolean false Identifies if the proxy refers to a digital card or not; Required if byProxy is true

Example responses

200 Response

{
  "identifier": "string",
  "customerIdentifier": "string",
  "externalIdentifier": "string",
  "isRefreshing": true,
  "proxyNumber": "string",
  "status": "Active",
  "balance": 0,
  "isProvisionedToWallet": true,
  "provisionedDate": "2019-08-24T14:15:22Z",
  "cardNumberLastFour": "string",
  "expiration": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "deepLink": "string",
  "tinyUrl": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "cardholder": {
    "firstName": "Maria",
    "lastName": "Wang",
    "email": "[email protected]",
    "phone": "5555550100",
    "dateOfBirth": "2000-01-01",
    "ssnLastFour": "string",
    "relation": "string",
    "other": "string",
    "billingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "mailingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Retrieve card information card

Get Card balance by identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/balance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cards/{identifier}/balance

Gets the card balance based on the identifier passed, as well as refreshing the card record with the current balance

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Example responses

200 Response

{
  "balance": 0
}

Responses

Status Meaning Description Schema
200 OK A balance retrieval response balance

Get Card status by identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cards/{identifier}/status

Gets the card status based on the identifier passed, as well as refreshing the card record with the current status

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Example responses

200 Response

{
  "status": 0
}

Responses

Status Meaning Description Schema
200 OK A status retrieval response status

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/related", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cards/{identifier}/related

Gets the cards related to the identified card

Name In Type Required Description
identifier path string true Identifies a card

Example responses

200 Response

{
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "externalIdentifier": "string",
      "isRefreshing": true,
      "proxyNumber": "string",
      "status": "Active",
      "balance": 0,
      "isProvisionedToWallet": true,
      "provisionedDate": "2019-08-24T14:15:22Z",
      "cardNumberLastFour": "string",
      "expiration": "2019-08-24T14:15:22Z",
      "creationDate": "2019-08-24T14:15:22Z",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "deepLink": "string",
      "tinyUrl": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "cardholder": {
        "firstName": "Maria",
        "lastName": "Wang",
        "email": "[email protected]",
        "phone": "5555550100",
        "dateOfBirth": "2000-01-01",
        "ssnLastFour": "string",
        "relation": "string",
        "other": "string",
        "billingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "mailingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ],
  "correlationId": "string"
}
Status Meaning Description Schema
200 OK Card get details cards

Reissue Card

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue \
  -H 'Content-Type: application/json'


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json


const inputBody = '{
  "externalIdentifier": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/reissue", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/reissue

Reissues a card. This endpoint allows users to reissue an existing card by reprinting and shipping to the cardholder. Reissue can be done in cases of loss of card or similar instances.

Body parameter

{
  "externalIdentifier": "string"
}

Parameters

Name In Type Required Description
identifier path string true Identifies a card
body body cardReissue true Reissue card information

Responses

Status Meaning Description Schema
200 OK Successful reissue None

Transfer Funds

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "targetCardIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/transfer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/transfer

Transfers funds. This endpoint allows users to transfer funds from one card/account to another.

Body parameter

{
  "targetCardIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Parameters

Name In Type Required Description
identifier path string true Identifies a card
body body cardTransferFunds true Transfer funds information such as amount, card identifier and comments

Example responses

200 Response

{
  "identifier": "string",
  "customerIdentifier": "string",
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24",
  "status": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "senderIdentifier": "string",
  "receiverIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "transferType": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Create or retrieve transfer response transfer

Activate Card

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/activate

Activates a card mapped to the identifier. This endpoint allows users to activate a deactivated or unused card.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
200 OK Successful activation None

Close Account

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/close", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/close

Closes an account mapped to the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
200 OK Success None

Suspend Card

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/suspend", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/suspend

Suspends a card. The user will not be able to make any transactions via a suspended card.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
200 OK Success None

Unsuspend Card

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unsuspend", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/unsuspend

Undo the suspension of a card. This endpoint enabled users to unsuspend a suspended card.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
200 OK Success None

Unmark Fraud on Account

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unmarkfraud", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/unmarkfraud

Unmarks fraud on an account. This endpoint allows users to unmark a reported fraud based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
200 OK Success None

Mark an account as Lost

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost HTTP/1.1
Host: apisandbox.dashsolutions.com



fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/marklost", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/marklost

Marks an account as Lost. This endpoint allows users to mark a reported lost card based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Responses

Status Meaning Description Schema
200 OK Success None

Update PIN

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin \
  -H 'Content-Type: application/json'


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json


const inputBody = '{
  "pin": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/pin", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/pin

This endpoint Updates PIN based on the identifier

Body parameter

{
  "pin": "string"
}

Parameters

Name In Type Required Description
identifier path string true Identifies a card
body body updatePin true Updated cardholder information

Responses

Status Meaning Description Schema
200 OK Success None

Cardholders

The Cardholders resource allows users to get and update cardholder and their details. Cardholders could be anyone with a valid card/account with Dash. The different endpoints available in this resource are - GET /cardholders GET /cardholders/{identifier} UT /cardholders/{identifier} and GET /cardholders/{identifier}/cards.

Learn more

Get Cardholders

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cardholders \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cardholders HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cardholders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cardholders',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cardholders', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cardholders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cardholders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cardholders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cardholders

Gets Cardholders. This endpoint allows users to retrieve Customer information.

Parameters

Name In Type Required Description
max query integer false Maximum number of records to return. If not specified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Customer identifier
firstName query string false Cardholder's First Name
lastName query string false Cardholder's Last Name
email query string false Cardholder's email
phone query string false Cardholder's Mobile Phone Number
ssnLastFour query string false Last 4 digits of SSN
other query string false Cardholder "other" field, associated directly to the cardholder and is primarily used for employee ID or other customer internal identifiers

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "ssnLastFour": "string",
      "relation": "string",
      "other": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Cardholder search results cardholderResults
400 Bad Request Standard error response errors

Get Cardholder Details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cardholders/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cardholders/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cardholders/{identifier}

Gets a Cardholder. Retrieves customer information based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a cardholder

Example responses

200 Response

{
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "ssnLastFour": "string",
  "relation": "string",
  "other": "string",
  "billingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Retrieve cardholder result cardholder

Update Cardholder

Code samples

# You can also use wget
curl -X PUT https://apisandbox.dashsolutions.com/cards/cardholders/{identifier} \
  -H 'Content-Type: application/json'


PUT https://apisandbox.dashsolutions.com/cards/cardholders/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json


const inputBody = '{
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phoneNumber": "5555550100",
  "nameOnCard": "Maria Wang",
  "ssn": "999994444",
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /cardholders/{identifier}

Updates a Cardholder. This endpoint allows users to update customer information based on the identifier and the update information.

Body parameter

{
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phoneNumber": "5555550100",
  "nameOnCard": "Maria Wang",
  "ssn": "999994444",
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Parameters

Name In Type Required Description
identifier path string true Identifies a cardholder
body body cardholderUpdate true Updated cardholder information

Responses

Status Meaning Description Schema
200 OK Cardholder updated None

Retrieve Cardholder Cards

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/cardholders/{identifier}/cards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cardholders/{identifier}/cards

Retrieves cards associated with a cardholder. This endpoint allows users to get all the cards associated with a cardholder based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a cardholder

Example responses

200 Response

{
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "externalIdentifier": "string",
      "isRefreshing": true,
      "proxyNumber": "string",
      "status": "Active",
      "balance": 0,
      "isProvisionedToWallet": true,
      "provisionedDate": "2019-08-24T14:15:22Z",
      "cardNumberLastFour": "string",
      "expiration": "2019-08-24T14:15:22Z",
      "creationDate": "2019-08-24T14:15:22Z",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "deepLink": "string",
      "tinyUrl": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "cardholder": {
        "firstName": "Maria",
        "lastName": "Wang",
        "email": "[email protected]",
        "phone": "5555550100",
        "dateOfBirth": "2000-01-01",
        "ssnLastFour": "string",
        "relation": "string",
        "other": "string",
        "billingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "mailingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ],
  "correlationId": "string"
}

Responses

Status Meaning Description Schema
200 OK Card get details cards
400 Bad Request Standard error response errors

Orders

The Orders resource lets users get, create, and retrieve card orders. Orders refer to placing an order for a Dash card, which could be a payment, reward, or any other card type, either physical or digital versions. The different endpoints available in this resource are - GET /orders POST/orders and GET /orders/{identifier}.

Learn more

Get Card Orders

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/orders \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/orders HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/orders',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/orders', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders

This endpoint allows users to search for the card orders that have been placed.

Parameters

Name In Type Required Description
max query integer false Maximum number of the card orders to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Unique identifier for the customers
externalIdentifier query string false Customer-supplied identifier of the record
status query string false Status of the record

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "attention": "Attn: Jim Smith - Rewards Department",
      "shippingMethod": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "status": "string",
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Order search results orderResults
400 Bad Request Standard error response errors

Create Card Orders

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/orders HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "customerIdentifier": "string",
  "orders": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "attention": "Attn: Rewards Department",
      "shippingMethod": "string",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "socialSecurityNumber": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "registrationCustomFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "load": {
        "externalIdentifier": "string",
        "fundingAccountIdentifier": "string",
        "loadValue": 0,
        "purseIdentifier": "string",
        "comment": "string",
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/orders',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/orders', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders

This endpoint enables users to create new cards. Users can create an order for a single card or bulk cards which could be of the payment, purchase or reward type.

Body parameter

{
  "customerIdentifier": "string",
  "orders": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "attention": "Attn: Rewards Department",
      "shippingMethod": "string",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "socialSecurityNumber": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "registrationCustomFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "load": {
        "externalIdentifier": "string",
        "fundingAccountIdentifier": "string",
        "loadValue": 0,
        "purseIdentifier": "string",
        "comment": "string",
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ]
}

Parameters

Name In Type Required Description
body body newOrders true Specify the card order details like customer details, mailing address, shipping information, type of the card ordered, etc."

Example responses

201 Response

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "attention": "Attn: Jim Smith - Rewards Department",
      "shippingMethod": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "status": "string",
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created On success the endpoint returns the customer details, billing and shipping details orderResults
400 Bad Request Standard error response errors

Get Card Order Details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/orders/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/orders/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/orders/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/orders/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/orders/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/orders/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/orders/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/orders/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/{identifier}

This endpoint enables users to retrieve a card order by passing an unique identifier.

Parameters

Name In Type Required Description
identifier path string true A unique string that identifies a card order

Example responses

200 Response

{
  "externalIdentifier": "string",
  "programIdentifier": "string",
  "isDigital": true,
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "other": "string",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "attention": "Attn: Jim Smith - Rewards Department",
  "shippingMethod": "string",
  "billingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "status": "string",
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Responses

Status Meaning Description Schema
200 OK Retrieve order result order

Create Single Card Order (Synchronous)

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/express/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/express/orders HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "customerIdentifier": "string",
  "order": {
    "externalIdentifier": "string",
    "programIdentifier": "string",
    "isDigital": true,
    "attention": "Attn: Rewards Department",
    "shippingMethod": "string",
    "shippingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "firstName": "Maria",
    "lastName": "Wang",
    "email": "[email protected]",
    "other": "string",
    "phone": "5555550100",
    "dateOfBirth": "2000-01-01",
    "socialSecurityNumber": "string",
    "billingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "mailingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "registrationCustomFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "load": {
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/express/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/express/orders',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/express/orders', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/express/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/express/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/express/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /express/orders

This endpoint enables users to create a card. Users can only create a single order for a single card which could be of the payment, purchase or reward type.

Body parameter

{
  "customerIdentifier": "string",
  "order": {
    "externalIdentifier": "string",
    "programIdentifier": "string",
    "isDigital": true,
    "attention": "Attn: Rewards Department",
    "shippingMethod": "string",
    "shippingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "firstName": "Maria",
    "lastName": "Wang",
    "email": "[email protected]",
    "other": "string",
    "phone": "5555550100",
    "dateOfBirth": "2000-01-01",
    "socialSecurityNumber": "string",
    "billingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "mailingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "registrationCustomFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "load": {
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  }
}

Parameters

Name In Type Required Description
body body newSingleOrder true Specify the card order details like customer details, mailing address, shipping information, type of the card ordered, etc."

Example responses

201 Response

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "attention": "Attn: Jim Smith - Rewards Department",
      "shippingMethod": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "status": "string",
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created On success the endpoint returns the customer details, billing and shipping details orderResults
400 Bad Request Standard error response errors

Registrations

The Registrations resource allows users to create, get, and retrieve card registrations. Registration refers to registering a card with Dash. The different endpoints under this resource are - GET /registrations POST /registrations and GET /registrations/{identifier}.

Learn more

Get Card Registrations

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/registrations \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/registrations HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/registrations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/registrations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/registrations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/registrations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/registrations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/registrations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /registrations

Gets card registrations. This end point allows users to search for card registrations

Parameters

Name In Type Required Description
max query integer false Maximum number of card registration records to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Customer identifier to search under, defaults to caller's customer
externalIdentifier query string false Customer-supplied identifier of the record

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "status": "string",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Registration search results registrationResults
400 Bad Request Standard error response errors

Create Card Registrations

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/registrations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/registrations HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "customerIdentifier": "string",
  "registrations": [
    {
      "externalIdentifier": "string",
      "cardIdentifier": "string",
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "socialSecurityNumber": "555555555",
      "dateOfBirth": "2000-01-01",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "load": {
        "externalIdentifier": "string",
        "fundingAccountIdentifier": "string",
        "loadValue": 0,
        "purseIdentifier": "string",
        "comment": "string",
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/registrations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/registrations',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/registrations', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/registrations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/registrations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/registrations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /registrations

Creates new card registrations. This end point allows users to create new card registrations.

Body parameter

{
  "customerIdentifier": "string",
  "registrations": [
    {
      "externalIdentifier": "string",
      "cardIdentifier": "string",
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "socialSecurityNumber": "555555555",
      "dateOfBirth": "2000-01-01",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "load": {
        "externalIdentifier": "string",
        "fundingAccountIdentifier": "string",
        "loadValue": 0,
        "purseIdentifier": "string",
        "comment": "string",
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ]
}

Parameters

Name In Type Required Description
body body newRegistrations true New card registration information

Example responses

201 Response

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "status": "string",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created Registration search results registrationResults
400 Bad Request Standard error response errors

Get Registration details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/registrations/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/registrations/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/registrations/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/registrations/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/registrations/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/registrations/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/registrations/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/registrations/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /registrations/{identifier}

Retrieves a card registration by identifier. This endpoint allows users tio get specific registration based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a registration

Example responses

200 Response

{
  "externalIdentifier": "string",
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "status": "string",
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Responses

Status Meaning Description Schema
200 OK Retrieve registration result registration

Loads

The Loads resource allows users to create, get, and search card loads. Loads refer to adding funds to your account/card. The different endpoints available in this resource are - GET /loads POST/loads and GET /loads/{identifier}.

Learn more

Get Card loads

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/loads \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/loads HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/loads',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/loads',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/loads', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/loads', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/loads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/loads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /loads

Gets card loads. This endpoint allows users to retrieve card load information such as load value, funding account, comments, and more.

Parameters

Name In Type Required Description
max query integer false Maximum number of load records to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Customer identifier to search under, defaults to caller's customer
externalIdentifier query string false Customer-supplied identifier of the record
cardIdentifier query string false Identifier of the card that was loaded
fundingIdentifier query string false Identifier of the funding account that was used for the load
status query string false Status of the record
amount query number false Amount of the load
creationStartDate query string(date) false Start date to search loads from
creationEndDate query string(date) false End date to search loads until

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "status": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Load search results loadResults
400 Bad Request Standard error response errors

Create Card Loads

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/loads \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/loads HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "customerIdentifier": "string",
  "loads": [
    {
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/loads',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/loads',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/loads', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/loads', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/loads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/loads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /loads

Creates card load. This endpoint allows users to add funds to a card from a specified account.

Body parameter

{
  "customerIdentifier": "string",
  "loads": [
    {
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ]
}

Parameters

Name In Type Required Description
body body newLoads true New card load information

Example responses

201 Response

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "status": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created Load search results loadResults
400 Bad Request Standard error response errors

Get Card Load Details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/loads/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/loads/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/loads/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/loads/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/loads/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/loads/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/loads/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/loads/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /loads/{identifier}

Gets card load details. This endpoint allows users to retrieve card load details based on a identifier

Parameters

Name In Type Required Description
identifier path string true Identifies a card load

Example responses

200 Response

{
  "identifier": "string",
  "externalIdentifier": "string",
  "fundingAccountIdentifier": "string",
  "cardIdentifier": "string",
  "loadValue": 0,
  "purseIdentifier": "string",
  "status": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Responses

Status Meaning Description Schema
200 OK Retrieve load result load

Unloads

The Unloads resource allows users to create an Unload and retrieve Unload details in bulk or by ID. Unloads refer to withdrawing funds to your account/card. The different endpoints available in this resource are - GET /unloads POST/cards/{identifier}/unload and GET /unloads/{identifier}.

Learn more

Get Card unloads

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/unloads \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/unloads HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/unloads',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/unloads',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/unloads', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/unloads', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/unloads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/unloads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /unloads

Gets card unloads. This endpoint allows users to get unload information such as fund value, account, comments and more.

Parameters

Name In Type Required Description
max query integer false Maximum number of unload records to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Customer identifier to search under, defaults to caller's customer
externalIdentifier query string false Customer-supplied identifier of the record

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "status": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Unload search results unloadResults
400 Bad Request Standard error response errors

Create Unload Card

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload \
  -H 'Content-Type: application/json'


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json


const inputBody = '{
  "externalIdentifier": "string",
  "unloadValue": 0,
  "fundingAccountIdentifier": "string",
  "purseIdentifier": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/unload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/unload

Unload funds from a card. This endpoint allows users to unload funds from a card by specifying the identifier.

Body parameter

{
  "externalIdentifier": "string",
  "unloadValue": 0,
  "fundingAccountIdentifier": "string",
  "purseIdentifier": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Parameters

Name In Type Required Description
identifier path string true Identifies a card
body body newUnload true Unload card information such as amount, comments and other

Responses

Status Meaning Description Schema
200 OK Successful unload None

Get Card Unload Details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/unloads/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/unloads/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/unloads/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/unloads/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/unloads/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/unloads/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/unloads/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/unloads/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /unloads/{identifier}

Gets card unloads by identifier. This endpoint allows users to get unload information such as fund value, account, comments and more based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies a card unload

Example responses

200 Response

{
  "identifier": "string",
  "externalIdentifier": "string",
  "fundingAccountIdentifier": "string",
  "cardIdentifier": "string",
  "loadValue": 0,
  "purseIdentifier": "string",
  "status": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Responses

Status Meaning Description Schema
200 OK Retrieve unload result unload

Replacements

The Replacements resource allows users to replace a card and retrieve replacement details by ID. Replacments refer to replacing one (typically lost or stolen) card with another on the same account. The different endpoints available in this resource are - POST/cards/{identifier}/replacement and GET /replacements/{identifier}.

Learn more

Replace Card

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "isLostStolen": true,
  "externalIdentifier": "string",
  "replacementCardIdentifier": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/cards/{identifier}/replace", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cards/{identifier}/replace

Replaces a card. This endpoint allows users to replace card a current card by printing and shipping a new card.

Body parameter

{
  "isLostStolen": true,
  "externalIdentifier": "string",
  "replacementCardIdentifier": "string"
}

Parameters

Name In Type Required Description
identifier path string true Identifies a card
body body newCardReplacement true New card information and shipping details

Example responses

200 Response

{
  "data": {
    "identifier": "string",
    "customerIdentifier": "string",
    "externalIdentifier": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "lastUpdateDate": "2019-08-24T14:15:22Z",
    "errorCode": "string",
    "errorMessage": "string",
    "status": "string",
    "originalCardIdentifier": "string",
    "newCardIdentifier": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Card replacement details Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data cardReplacement false none Card replacement details
»» identifier string false none Dash Card Identifier
»» customerIdentifier string false none Identifier to identify a customer
»» externalIdentifier string false none External identifier supplied by the customer
»» creationDate string(date-time) false none Replacement creation date
»» lastUpdateDate string(date-time) false none Replacement last updated date
»» errorCode string false none Code describing a processing error
»» errorMessage string false none Human-readable error message
»» status string false none Order status of the card order
»» originalCardIdentifier string false none The identifier of the card that was replaced
»» newCardIdentifier string false none The identifier of the new replacement card

Get Card Replacements

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/replacements \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/replacements HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/replacements',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/replacements',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/replacements', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/replacements', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/replacements");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/replacements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /replacements

This endpoint allows users to search for the card replacements that have been placed.

Parameters

Name In Type Required Description
max query integer false Maximum number of the card replacements to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Unique identifier for the customers
externalIdentifier query string false Customer-supplied identifier of the record
cardIdentifier query string false Identifier of a card related to the desired replacements
status query string false Status of the record

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "externalIdentifier": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "errorCode": "string",
      "errorMessage": "string",
      "status": "string",
      "originalCardIdentifier": "string",
      "newCardIdentifier": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Replacements search results replacementResults
400 Bad Request Standard error response errors

Get Card Replacement Details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/replacements/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/replacements/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/replacements/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/replacements/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/replacements/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/replacements/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/replacements/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/replacements/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /replacements/{identifier}

Gets card replacement details. This endpoint allows users to retrieve card replacement details based on a identifier

Parameters

Name In Type Required Description
identifier path string true Identifies a card replacement

Example responses

200 Response

{
  "data": {
    "identifier": "string",
    "customerIdentifier": "string",
    "externalIdentifier": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "lastUpdateDate": "2019-08-24T14:15:22Z",
    "errorCode": "string",
    "errorMessage": "string",
    "status": "string",
    "originalCardIdentifier": "string",
    "newCardIdentifier": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Card replacement details Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data cardReplacement false none Card replacement details
»» identifier string false none Dash Card Identifier
»» customerIdentifier string false none Identifier to identify a customer
»» externalIdentifier string false none External identifier supplied by the customer
»» creationDate string(date-time) false none Replacement creation date
»» lastUpdateDate string(date-time) false none Replacement last updated date
»» errorCode string false none Code describing a processing error
»» errorMessage string false none Human-readable error message
»» status string false none Order status of the card order
»» originalCardIdentifier string false none The identifier of the card that was replaced
»» newCardIdentifier string false none The identifier of the new replacement card

Programs

The Programs resource allows users to get programs in bulk or by ID. Programs refer to the banking plans to which the user subscribes. Like payments, payroll, or rewards. The different endpoints available in this resource are - GET /programs and GET /programs/{identifier}.

Learn more

Get Card Programs

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/programs \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/programs HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/programs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/programs',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/programs', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/programs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/programs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/programs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /programs

Gets card programs. This end point allows users to search for card programs and get the program details

Parameters

Name In Type Required Description
max query integer false Maximum number of program records to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Customer identifier to search under, defaults to caller's customer
v1Identifier query string false API version 1 identifier to search for

Example responses

200 Response

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Program search results programResults
400 Bad Request Standard error response errors

Get Card Program by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/programs/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/programs/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/programs/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/programs/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/programs/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/programs/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/programs/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/programs/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /programs/{identifier}

Gets card programs by identifier. This end point allows users to search for card programs and get the program details based on identifier

Parameters

Name In Type Required Description
identifier path string true Identifies a program

Example responses

200 Response

{
  "identifier": "string",
  "externalIdentifier": "string"
}

Responses

Status Meaning Description Schema
200 OK Retrieve program result program

Get Card Program Inventory by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/programs/{identifier}/inventory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /programs/{identifier}/inventory

Gets card program inventory by identifier. This end point allows users to retrieve inventory information for a program

Parameters

Name In Type Required Description
identifier path string true Identifies a program

Example responses

200 Response

{
  "inventoryCount": 0,
  "activeCount": 0
}

Responses

Status Meaning Description Schema
200 OK Retrieve program inventory result inventory

Funding

The Funding resource allows users to get funding account details in bulk or by ID. Funding refers to adding funds to an account. A funding account is the account through which fund transfer happens. The different endpoints available in this resource are - GET /funding-accounts and GET /funding-accounts/{identifier}.

Learn more

Get Funding Accounts

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/funding-accounts \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/funding-accounts HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/funding-accounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/funding-accounts',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/funding-accounts', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/funding-accounts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/funding-accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/funding-accounts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /funding-accounts

Gets funding Accounts. This endpoint allows users to retrieve funding account information such as program, funding, and more.

Parameters

Name In Type Required Description
max query integer false Maximum number of funding account records to return. If unspecified, returns 50 records by default.
token query string false A continuation token for pagination
customerIdentifier query string false Customer identifier to search under, defaults to caller's customer

Example responses

200 Response

{
  "identifier": "string",
  "externalIdentifier": "string",
  "customerIdentifier": "string",
  "programIdentifier": "string",
  "fundingIdentifier": "string",
  "fundingType": "string",
  "isRefreshing": true,
  "balance": 0
}

Responses

Status Meaning Description Schema
200 OK Funding account result fundingAccountDetailed
400 Bad Request Standard error response errors

Get Funding Account Details by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /funding-accounts/{identifier}

Gets funding Accounts by identifier. This endpoint allows users to retrieve funding account information such as program, funding, and more based on the identifier.

Parameters

Name In Type Required Description
identifier path string true Identifies the funding account

Example responses

200 Response

{
  "identifier": "string",
  "externalIdentifier": "string",
  "customerIdentifier": "string",
  "programIdentifier": "string",
  "fundingIdentifier": "string",
  "fundingType": "string",
  "isRefreshing": true,
  "balance": 0
}

Responses

Status Meaning Description Schema
200 OK Funding account result fundingAccountDetailed

Get Funding Account Balance by Identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/balance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /funding-accounts/{identifier}/balance

Gets the funding account balance by identifier as well as updating the funding account record with the current value

Parameters

Name In Type Required Description
identifier path string true Identifies the funding account

Example responses

200 Response

{
  "balance": 0
}

Responses

Status Meaning Description Schema
200 OK A balance retrieval response balance

Transfer Funds

Code samples

# You can also use wget
curl -X POST https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer HTTP/1.1
Host: apisandbox.dashsolutions.com
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "targetFundingIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://apisandbox.dashsolutions.com/cards/funding-accounts/{identifier}/transfer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /funding-accounts/{identifier}/transfer

Transfers funds between funding accounts. This endpoint allows users to transfer funds from one funding account to another.

Body parameter

{
  "targetFundingIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Parameters

Name In Type Required Description
identifier path string true Identifies a funding account
body body fundingTransferFunds true Transfer funds information such as amount, target funding account identifier and comments

Example responses

200 Response

{
  "identifier": "string",
  "customerIdentifier": "string",
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24",
  "status": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "senderIdentifier": "string",
  "receiverIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "transferType": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Create or retrieve transfer response transfer

Transfers

The Transfers resource allows users to get money transfer details in bulk or by ID. Transfers refers to moving funds between related accounts. The different endpoints available in this resource are - GET /transfers and GET /transfers/{identifier}.

Learn more

Get Transfers

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/transfers \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/transfers HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/transfers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/transfers',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/transfers', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/transfers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/transfers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/transfers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /transfers

Gets Transfers in bulk. The details fetched are based on the token and optional parameters. This endpoint allows users to retrieve details about money transfers, such as - sender and receiver identifiers, status, transfer type, and more.

Parameters

Name In Type Required Description
max query integer false Maximum number of Card records to return. If unspecified, 50 records are returned by default.
token query string false A continuation token for pagination
customerIdentifier query string false Unique reference to identify a Customer
externalIdentifier query string false External identifier supplied on creating a card used to identify a card.
senderIdentifier query string false Identifier of the account to which the funds were tranferred.
receiverIdentifier query string false Identifier of the account from which the funds were tranferred.
transferType query string false The (account) type of the transfer.

Example responses

200 Response

{
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24",
      "status": "string",
      "errorCode": "string",
      "errorMessage": "string",
      "senderIdentifier": "string",
      "receiverIdentifier": "string",
      "amount": 0,
      "comment": "string",
      "transferType": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ],
  "correlationId": "string"
}

Responses

Status Meaning Description Schema
200 OK List of transfers transfers
400 Bad Request Standard error response errors

Get Transfer by identifier

Code samples

# You can also use wget
curl -X GET https://apisandbox.dashsolutions.com/cards/transfers/{identifier} \
  -H 'Accept: application/json'


GET https://apisandbox.dashsolutions.com/cards/transfers/{identifier} HTTP/1.1
Host: apisandbox.dashsolutions.com
Accept: application/json



const headers = {
  'Accept':'application/json'
};

fetch('https://apisandbox.dashsolutions.com/cards/transfers/{identifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://apisandbox.dashsolutions.com/cards/transfers/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://apisandbox.dashsolutions.com/cards/transfers/{identifier}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://apisandbox.dashsolutions.com/cards/transfers/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://apisandbox.dashsolutions.com/cards/transfers/{identifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://apisandbox.dashsolutions.com/cards/transfers/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /transfers/{identifier}

Gets Transfer details based on the identifier passed.

Parameters

Name In Type Required Description
identifier path string true Identifies a card

Example responses

200 Response

{
  "identifier": "string",
  "customerIdentifier": "string",
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24",
  "status": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "senderIdentifier": "string",
  "receiverIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "transferType": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Create or retrieve transfer response transfer

Schemas

errors

[
  {
    "errorCode": "string",
    "errorMessage": "string",
    "fieldName": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [error] false none none

error

{
  "errorCode": "string",
  "errorMessage": "string",
  "fieldName": "string"
}

Properties

Name Type Required Restrictions Description
errorCode string false none Error code
errorMessage string false none Error message
fieldName string false none Error field

creationBase

{
  "customerIdentifier": "string"
}

Properties

Name Type Required Restrictions Description
customerIdentifier string false none Identifies a customer

cards

{
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "externalIdentifier": "string",
      "isRefreshing": true,
      "proxyNumber": "string",
      "status": "Active",
      "balance": 0,
      "isProvisionedToWallet": true,
      "provisionedDate": "2019-08-24T14:15:22Z",
      "cardNumberLastFour": "string",
      "expiration": "2019-08-24T14:15:22Z",
      "creationDate": "2019-08-24T14:15:22Z",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "deepLink": "string",
      "tinyUrl": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "cardholder": {
        "firstName": "Maria",
        "lastName": "Wang",
        "email": "[email protected]",
        "phone": "5555550100",
        "dateOfBirth": "2000-01-01",
        "ssnLastFour": "string",
        "relation": "string",
        "other": "string",
        "billingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "mailingAddress": {
          "line1": "1900 Sesame Street",
          "line2": "Suite 400",
          "locality": "New York",
          "region": "NY",
          "country": "USA",
          "postalCode": "10023"
        },
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ],
  "correlationId": "string"
}

Properties

Name Type Required Restrictions Description
results [card] false none Array of cards
correlationId string false none none

card

{
  "identifier": "string",
  "customerIdentifier": "string",
  "externalIdentifier": "string",
  "isRefreshing": true,
  "proxyNumber": "string",
  "status": "Active",
  "balance": 0,
  "isProvisionedToWallet": true,
  "provisionedDate": "2019-08-24T14:15:22Z",
  "cardNumberLastFour": "string",
  "expiration": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "deepLink": "string",
  "tinyUrl": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "cardholder": {
    "firstName": "Maria",
    "lastName": "Wang",
    "email": "[email protected]",
    "phone": "5555550100",
    "dateOfBirth": "2000-01-01",
    "ssnLastFour": "string",
    "relation": "string",
    "other": "string",
    "billingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "mailingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
identifier string false none Dash Card Identifier
customerIdentifier string false none Identifier to identify a customer
externalIdentifier string false none none
isRefreshing boolean false none Flag to indicate data refresh
proxyNumber string false none Card proxy number to identify a Card
status string false none Status of the card if Active or Suspended
balance number false none Card balance
isProvisionedToWallet boolean false none Flag to know if wallet is provisioned for a Card
provisionedDate string(date-time) false none Card provisioned date
cardNumberLastFour string false none Masked number of Card
expiration string(date-time) false none Card expiry date
creationDate string(date-time) false none Date and time when the record was created. Not the date the card was created.
lastUpdateDate string(date-time) false none Last date and time the record was updated.
deepLink string false none Deep link to the cardholder site associated to the card, if configured
tinyUrl string false none Tiny URL pointing to the deep link for use in character-constrained situations
customFields customFields false none Custom Fields that can be associated to a specific object
cardholder cardholder false none none

temporaryToken

{
  "token": "string",
  "correlationId": "string"
}

Properties

Name Type Required Restrictions Description
token string false none Temporary token to identify a card
correlationId string false none Unique identifier for a request

secureCard

{
  "identifier": "string",
  "routingNumber": "string",
  "bankAccountNumber": "string",
  "cardNumber": "string",
  "proxyNumber": "string",
  "cardExpiration": "string",
  "cardVerificationValue": "string"
}

Properties

Name Type Required Restrictions Description
identifier string false none Dash Card Identifier
routingNumber string false none DDA routing number
bankAccountNumber string false none DDA bank account number
cardNumber string false none Full card number
proxyNumber string false none FIS Proxy number
cardExpiration string false none Card Expiration Date
cardVerificationValue string false none CVV/CVC/CSC on the card

cardholderUpdate

{
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phoneNumber": "5555550100",
  "nameOnCard": "Maria Wang",
  "ssn": "999994444",
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
firstName string false none Cardholder First Name
lastName string false none Cardholder Last Name
email string false none Cardholder Email
phoneNumber string false none Cardholder Phone Number
nameOnCard string false none Cardholder Name as on Card
ssn string false none Social security number
mailingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Cardholder Mailing Address

continued

Name Type Required Restrictions Description
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Cardholder custom fields

updatePin

{
  "pin": "string"
}

Properties

Name Type Required Restrictions Description
pin string true none New Account PIN

newCardReplacement

{
  "isLostStolen": true,
  "externalIdentifier": "string",
  "replacementCardIdentifier": "string"
}

Properties

Name Type Required Restrictions Description
isLostStolen boolean false none If the card is in stolen state
externalIdentifier string false none An identifier used to identify the card
replacementCardIdentifier string false none An identifier used to identify the replaced card

replacementResults

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "externalIdentifier": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "errorCode": "string",
      "errorMessage": "string",
      "status": "string",
      "originalCardIdentifier": "string",
      "newCardIdentifier": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [cardReplacement] false none Replacement results

cardReplacement

{
  "identifier": "string",
  "customerIdentifier": "string",
  "externalIdentifier": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "errorCode": "string",
  "errorMessage": "string",
  "status": "string",
  "originalCardIdentifier": "string",
  "newCardIdentifier": "string"
}

Card replacement details

Properties

Name Type Required Restrictions Description
identifier string false none Dash Card Identifier
customerIdentifier string false none Identifier to identify a customer
externalIdentifier string false none External identifier supplied by the customer
creationDate string(date-time) false none Replacement creation date
lastUpdateDate string(date-time) false none Replacement last updated date
errorCode string false none Code describing a processing error
errorMessage string false none Human-readable error message
status string false none Order status of the card order
originalCardIdentifier string false none The identifier of the card that was replaced
newCardIdentifier string false none The identifier of the new replacement card

cardAssignment

{
  "cardholderIdentifier": "string",
  "externalIdentifier": "string"
}

Properties

Name Type Required Restrictions Description
cardholderIdentifier string true none Identifies Cardholder
externalIdentifier string false none External identifier issued by Dash, used to identify the card

newUnload

{
  "externalIdentifier": "string",
  "unloadValue": 0,
  "fundingAccountIdentifier": "string",
  "purseIdentifier": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
unloadValue number true none Amount of unload
fundingAccountIdentifier string true none Identifies the funding account
purseIdentifier string false none Identifies the funding wallet
comment string false none Any comments on the transaction
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value unload

cardTransferFunds

{
  "targetCardIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
targetCardIdentifier string true none Identifies the target account/card
amount number true none Amount of transfer
comment string false none Any comments on the transaction
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value transfer

cardReissue

{
  "externalIdentifier": "string"
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card

cardholderResults

{
  "continuationToken": "string",
  "results": [
    {
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "ssnLastFour": "string",
      "relation": "string",
      "other": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [cardholder] false none cCardholder results

cardholder

{
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "ssnLastFour": "string",
  "relation": "string",
  "other": "string",
  "billingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
firstName string false none Cardholder first name
lastName string false none Cardholder last name
email string false none Cardholder email ID
phone string false none Cardholder phone number
dateOfBirth string(date) false none Cardholder date of birth
ssnLastFour string false none Last 4 of cardholder SSN
relation string false none Cardholder's relationship to the account owner
other string false none Client-specific cardholder value
billingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Cardholder billing address

continued

Name Type Required Restrictions Description
mailingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Cardholder mailing address

continued

Name Type Required Restrictions Description
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to the cardholder

orderResults

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "attention": "Attn: Jim Smith - Rewards Department",
      "shippingMethod": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "status": "string",
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [order] false none order results

orderSingleResult

{
  "continuationToken": "string",
  "order": {
    "externalIdentifier": "string",
    "programIdentifier": "string",
    "isDigital": true,
    "firstName": "Maria",
    "lastName": "Wang",
    "email": "[email protected]",
    "other": "string",
    "phone": "5555550100",
    "dateOfBirth": "2000-01-01",
    "attention": "Attn: Jim Smith - Rewards Department",
    "shippingMethod": "string",
    "billingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "shippingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "mailingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "status": "string",
    "creationDate": "2019-08-24",
    "lastUpdateDate": "2019-08-24"
  }
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
order order false none none

order

{
  "externalIdentifier": "string",
  "programIdentifier": "string",
  "isDigital": true,
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "other": "string",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "attention": "Attn: Jim Smith - Rewards Department",
  "shippingMethod": "string",
  "billingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "status": "string",
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
programIdentifier string false none Identifies a Program
isDigital boolean false none True if the card is digital rather than physical
firstName string false none User's first name
lastName string false none User's last name
email string false none User's email ID
other string false none Typically used for employeeID's or Memberships Numbers. This field can also be used as validation on the cardholder registration
phone string false none User's phone number
dateOfBirth string(date) false none User's date of birth
attention string false none Attention or alert message for shipping and mailing of the card order
shippingMethod string false none Shipping method for the card order
billingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Billing address for the card order

continued

Name Type Required Restrictions Description
shippingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Shipping address for the card order

continued

Name Type Required Restrictions Description
mailingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Mailing address for the card order

continued

Name Type Required Restrictions Description
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to the card

continued

Name Type Required Restrictions Description
status string false none Order status of the card order
creationDate string(date) false none Order date of the card order
lastUpdateDate string(date) false none Last updated timestamp of the card order

newOrders

{
  "customerIdentifier": "string",
  "orders": [
    {
      "externalIdentifier": "string",
      "programIdentifier": "string",
      "isDigital": true,
      "attention": "Attn: Rewards Department",
      "shippingMethod": "string",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "socialSecurityNumber": "string",
      "billingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "registrationCustomFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "load": {
        "externalIdentifier": "string",
        "fundingAccountIdentifier": "string",
        "loadValue": 0,
        "purseIdentifier": "string",
        "comment": "string",
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous creationBase false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» orders [oneOf] false none Orders for the card

oneOf

Name Type Required Restrictions Description
»» anonymous newPersonalizedOrder false none New order for a single personalized preregistered card.

xor

Name Type Required Restrictions Description
»» anonymous newInstantIssueOrder false none New order for a one or more unregistered cards

newSingleOrder

{
  "customerIdentifier": "string",
  "order": {
    "externalIdentifier": "string",
    "programIdentifier": "string",
    "isDigital": true,
    "attention": "Attn: Rewards Department",
    "shippingMethod": "string",
    "shippingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "firstName": "Maria",
    "lastName": "Wang",
    "email": "[email protected]",
    "other": "string",
    "phone": "5555550100",
    "dateOfBirth": "2000-01-01",
    "socialSecurityNumber": "string",
    "billingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "mailingAddress": {
      "line1": "1900 Sesame Street",
      "line2": "Suite 400",
      "locality": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10023"
    },
    "registrationCustomFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    },
    "load": {
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  }
}

Properties

allOf

Name Type Required Restrictions Description
anonymous creationBase false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» order newPersonalizedOrder false none New order for a single personalized preregistered card.

newOrder

{
  "externalIdentifier": "string",
  "programIdentifier": "string",
  "isDigital": true,
  "attention": "Attn: Rewards Department",
  "shippingMethod": "string",
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
programIdentifier string false none Identifies a Program
isDigital boolean false none True if the new card is digital rather than physical
attention string false none Attention or alert message for shipping and mailing of the new card order
shippingMethod string false none Shipping method for the new card order
shippingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Shipping address for the new card order

continued

Name Type Required Restrictions Description
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to the card

newPersonalizedOrder

{
  "externalIdentifier": "string",
  "programIdentifier": "string",
  "isDigital": true,
  "attention": "Attn: Rewards Department",
  "shippingMethod": "string",
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "other": "string",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "socialSecurityNumber": "string",
  "billingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "registrationCustomFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "load": {
    "externalIdentifier": "string",
    "fundingAccountIdentifier": "string",
    "loadValue": 0,
    "purseIdentifier": "string",
    "comment": "string",
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    }
  }
}

New order for a single personalized preregistered card.

Properties

allOf

Name Type Required Restrictions Description
anonymous newOrder false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» firstName string false none User's first name
» lastName string false none User's last name
» email string false none User's email ID
» other string false none Typically used for employeeID's or Memberships Numbers. This field can also be used as validation on the cardholder registration
» phone string false none User's phone number
» dateOfBirth string(date) false none User's date of birth
» socialSecurityNumber string false none User's SSN number
» billingAddress any false none none

allOf

Name Type Required Restrictions Description
»» anonymous address false none none

and

Name Type Required Restrictions Description
»» anonymous any false none Billing address for the card order

continued

Name Type Required Restrictions Description
» mailingAddress any true none none

allOf

Name Type Required Restrictions Description
»» anonymous address false none none

and

Name Type Required Restrictions Description
»» anonymous any false none Mailing address for the card order

continued

Name Type Required Restrictions Description
» registrationCustomFields any false none none

allOf

Name Type Required Restrictions Description
»» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
»» anonymous any false none Custom Fields that can be associated to the cardholder

continued

Name Type Required Restrictions Description
» load newSecondaryLoad false none none

newInstantIssueOrder

{
  "externalIdentifier": "string",
  "programIdentifier": "string",
  "isDigital": true,
  "attention": "Attn: Rewards Department",
  "shippingMethod": "string",
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "quantity": 0
}

New order for a one or more unregistered cards

Properties

allOf

Name Type Required Restrictions Description
anonymous newOrder false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» quantity number false none Number of instant issue cards order

registrationResults

{
  "continuationToken": "string",
  "results": [
    {
      "externalIdentifier": "string",
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "phone": "5555550100",
      "dateOfBirth": "2000-01-01",
      "status": "string",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [registration] false none Registration results

registration

{
  "externalIdentifier": "string",
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "phone": "5555550100",
  "dateOfBirth": "2000-01-01",
  "status": "string",
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
firstName string false none User's first name
lastName string false none User's last name
email string false none User's email ID
phone string false none User's phone number
dateOfBirth string(date) false none User's date of birth
status string false none Status of card registration
shippingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Shipping address for the card order

continued

Name Type Required Restrictions Description
mailingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Mailing address for the card order

continued

Name Type Required Restrictions Description
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to the cardholder

continued

Name Type Required Restrictions Description
creationDate string(date) false none Creation date of registration for the card order
lastUpdateDate string(date) false none Last update date of registration for the card order

newRegistrations

{
  "customerIdentifier": "string",
  "registrations": [
    {
      "externalIdentifier": "string",
      "cardIdentifier": "string",
      "firstName": "Maria",
      "lastName": "Wang",
      "email": "[email protected]",
      "other": "string",
      "phone": "5555550100",
      "socialSecurityNumber": "555555555",
      "dateOfBirth": "2000-01-01",
      "shippingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "mailingAddress": {
        "line1": "1900 Sesame Street",
        "line2": "Suite 400",
        "locality": "New York",
        "region": "NY",
        "country": "USA",
        "postalCode": "10023"
      },
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "load": {
        "externalIdentifier": "string",
        "fundingAccountIdentifier": "string",
        "loadValue": 0,
        "purseIdentifier": "string",
        "comment": "string",
        "customFields": {
          "customField1": "string",
          "customField2": "string",
          "customField3": "string",
          "customField4": "string",
          "customField5": "string"
        }
      }
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous creationBase false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» registrations [newRegistration] false none New registration details

newRegistration

{
  "externalIdentifier": "string",
  "cardIdentifier": "string",
  "firstName": "Maria",
  "lastName": "Wang",
  "email": "[email protected]",
  "other": "string",
  "phone": "5555550100",
  "socialSecurityNumber": "555555555",
  "dateOfBirth": "2000-01-01",
  "shippingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "mailingAddress": {
    "line1": "1900 Sesame Street",
    "line2": "Suite 400",
    "locality": "New York",
    "region": "NY",
    "country": "USA",
    "postalCode": "10023"
  },
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "load": {
    "externalIdentifier": "string",
    "fundingAccountIdentifier": "string",
    "loadValue": 0,
    "purseIdentifier": "string",
    "comment": "string",
    "customFields": {
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
cardIdentifier string false none Identifies card
firstName string true none User's first name
lastName string true none User's last name
email string false none User's email ID
other string false none Typically used for employeeID's or Memberships Numbers. This field can also be used as validation on the cardholder registration
phone string false none User's phone number
socialSecurityNumber string true none User's SSN number
dateOfBirth string(date) false none User's date of birth
shippingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Shipping address for the card registration

continued

Name Type Required Restrictions Description
mailingAddress any false none none

allOf

Name Type Required Restrictions Description
» anonymous address false none none

and

Name Type Required Restrictions Description
» anonymous any false none Mailing address for the card registration

continued

Name Type Required Restrictions Description
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to the cardholder

continued

Name Type Required Restrictions Description
load any false none none

allOf

Name Type Required Restrictions Description
» anonymous newSecondaryLoad false none none

and

Name Type Required Restrictions Description
» anonymous any false none Load amount for the card

loadResults

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "status": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [load] false none Load results

load

{
  "identifier": "string",
  "externalIdentifier": "string",
  "fundingAccountIdentifier": "string",
  "cardIdentifier": "string",
  "loadValue": 0,
  "purseIdentifier": "string",
  "status": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
externalIdentifier string false none External identifier issued by Dash, used to identify the card
fundingAccountIdentifier string false none Identifier of the funding account used to load the card
cardIdentifier string false none Identifier of the card to load
loadValue number false none Amount to load on the card
purseIdentifier string false none Identifier of the purse that was loaded
status string false none Status of the load
comment string false none Comment to display to the cardholder in their transaction history
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value load

continued

Name Type Required Restrictions Description
creationDate string(date) false none Load creation date
lastUpdateDate string(date) false none Load last update date

newLoads

{
  "customerIdentifier": "string",
  "loads": [
    {
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous creationBase false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» loads [newLoad] false none New loads result

newLoad

{
  "externalIdentifier": "string",
  "fundingAccountIdentifier": "string",
  "cardIdentifier": "string",
  "loadValue": 0,
  "purseIdentifier": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
fundingAccountIdentifier string true none Identifier of the funding account used to load the card
cardIdentifier string true none Identifier of the card to load
loadValue number true none Amount to load on the card
purseIdentifier string false none Identifier of the purse that was loaded
comment string false none Comment to display to the cardholder in their transaction history
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value load

newSecondaryLoad

{
  "externalIdentifier": "string",
  "fundingAccountIdentifier": "string",
  "loadValue": 0,
  "purseIdentifier": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
externalIdentifier string false none External identifier issued by Dash, used to identify the card
fundingAccountIdentifier string true none Identifier of the funding account used to load the card
loadValue number true none Amount to load on the card
purseIdentifier string false none Identifier of the purse that was loaded
comment string false none Comment to display to the cardholder in their transaction history
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value load

unloadResults

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string",
      "fundingAccountIdentifier": "string",
      "cardIdentifier": "string",
      "loadValue": 0,
      "purseIdentifier": "string",
      "status": "string",
      "comment": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      },
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [unload] false none Unload results

unload

{
  "identifier": "string",
  "externalIdentifier": "string",
  "fundingAccountIdentifier": "string",
  "cardIdentifier": "string",
  "loadValue": 0,
  "purseIdentifier": "string",
  "status": "string",
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  },
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24"
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
externalIdentifier string false none External identifier issued by Dash, used to identify the card
fundingAccountIdentifier string false none Identifier of the funding account used to unload the card
cardIdentifier string false none Identifier of the card to unload
loadValue number false none Amount to unload from the card
purseIdentifier string false none Identifier of the purse that was unloaded
status string false none Status of the unload
comment string false none Comment to display to the cardholder in their transaction history
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value unload

continued

Name Type Required Restrictions Description
creationDate string(date) false none Unload creation date
lastUpdateDate string(date) false none Unload last update date

programResults

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [program] false none Program results

program

{
  "identifier": "string",
  "externalIdentifier": "string"
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
externalIdentifier string false none External identifier issued by Dash, used to identify the card

inventory

{
  "inventoryCount": 0,
  "activeCount": 0
}

Properties

Name Type Required Restrictions Description
inventoryCount number false none Number of unregistered cards waiting in inventory
activeCount number false none Number of cards that have been registered and are no longer in inventory

statementResults

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "date": "2000-01-01"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [statement] false none Card statement results

statement

{
  "identifier": "string",
  "date": "2000-01-01"
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
date string(date) false none Card statement date

statementDetailed

{
  "identifier": "string",
  "cardIdentifier": "string",
  "closingDate": "2000-01-01",
  "lastDate": "2000-01-01",
  "purseNumber": "string",
  "openingBalance": "string",
  "credits": "string",
  "purchases": "string",
  "ATM": "string",
  "fee": "string",
  "newBalance": "string",
  "transactions": [
    {
      "transactionDate": "2000-01-01",
      "postDate": "2000-01-01",
      "referenceNumber": "string",
      "transactionDetail": "string",
      "debitAmount": "string",
      "creditAmount": "string",
      "detailType": "string",
      "detailDescription": "string",
      "longPostDate": "2000-01-01",
      "cardNumber": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
cardIdentifier string false none Identifies a card
closingDate string(date) false none Statement closing date
lastDate string(date) false none Statement last date
purseNumber string false none Card purse number
openingBalance string false none card starting balance amount
credits string false none Credits received
purchases string false none Purchases made on the card
ATM string false none ATM details
fee string false none Fees charged
newBalance string false none Updated balance in the card
transactions [statementTransaction] false none Transaction history on the card

statementTransaction

{
  "transactionDate": "2000-01-01",
  "postDate": "2000-01-01",
  "referenceNumber": "string",
  "transactionDetail": "string",
  "debitAmount": "string",
  "creditAmount": "string",
  "detailType": "string",
  "detailDescription": "string",
  "longPostDate": "2000-01-01",
  "cardNumber": 0
}

Properties

Name Type Required Restrictions Description
transactionDate string(date) false none Card transaction date
postDate string(date) false none Card post date
referenceNumber string false none Transaction reference date
transactionDetail string false none Transaction details
debitAmount string false none Amount debited
creditAmount string false none Amount credited
detailType string false none none
detailDescription string false none none
longPostDate string(date) false none none
cardNumber integer false none none

fundingAccountResults

{
  "continuationToken": "string",
  "results": [
    {
      "identifier": "string",
      "externalIdentifier": "string",
      "customerIdentifier": "string",
      "programIdentifier": "string",
      "fundingIdentifier": "string",
      "fundingType": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
continuationToken string false none A continuation token for pagination
results [fundingAccount] false none Funding account results

fundingAccount

{
  "identifier": "string",
  "externalIdentifier": "string",
  "customerIdentifier": "string",
  "programIdentifier": "string",
  "fundingIdentifier": "string",
  "fundingType": "string"
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
externalIdentifier string false none External identifier issued by Dash, used to identify the card
customerIdentifier string false none Identifies customer
programIdentifier string false none Identifies program
fundingIdentifier string false none Identifies funding account
fundingType string false none Specifies the funding type whether: Manual, ACH, Batch, Virtual Funding Account

fundingAccountDetailed

{
  "identifier": "string",
  "externalIdentifier": "string",
  "customerIdentifier": "string",
  "programIdentifier": "string",
  "fundingIdentifier": "string",
  "fundingType": "string",
  "isRefreshing": true,
  "balance": 0
}

Properties

allOf

Name Type Required Restrictions Description
anonymous fundingAccount false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» isRefreshing boolean false none Whether the funding account data is currently being refreshed
» balance number false none Current available balance

fundingTransferFunds

{
  "targetFundingIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
targetFundingIdentifier string true none Identifies the target funding account
amount number true none Amount of transfer
comment string false none Any comments on the transaction
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value transfer

transfers

{
  "results": [
    {
      "identifier": "string",
      "customerIdentifier": "string",
      "creationDate": "2019-08-24",
      "lastUpdateDate": "2019-08-24",
      "status": "string",
      "errorCode": "string",
      "errorMessage": "string",
      "senderIdentifier": "string",
      "receiverIdentifier": "string",
      "amount": 0,
      "comment": "string",
      "transferType": "string",
      "customFields": {
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "customField4": "string",
        "customField5": "string"
      }
    }
  ],
  "correlationId": "string"
}

Properties

Name Type Required Restrictions Description
results [transfer] false none Array of transfers
correlationId string false none none

transfer

{
  "identifier": "string",
  "customerIdentifier": "string",
  "creationDate": "2019-08-24",
  "lastUpdateDate": "2019-08-24",
  "status": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "senderIdentifier": "string",
  "receiverIdentifier": "string",
  "amount": 0,
  "comment": "string",
  "transferType": "string",
  "customFields": {
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "customField4": "string",
    "customField5": "string"
  }
}

Properties

Name Type Required Restrictions Description
identifier string false none Unique reference number
customerIdentifier string false none Identifier of the owning customer
creationDate string(date) false none Unload creation date
lastUpdateDate string(date) false none Unload last update date
status string false none Status of the unload
errorCode string false none Error code
errorMessage string false none Error message
senderIdentifier string false none Identifies the source of the transfer
receiverIdentifier string false none Identifies the target of the transfer
amount number false none Amount to transfer
comment string false none Any comments on the transaction
transferType string false none The type of transfer
customFields any false none none

allOf

Name Type Required Restrictions Description
» anonymous customFields false none Custom Fields that can be associated to a specific object

and

Name Type Required Restrictions Description
» anonymous any false none Custom Fields that can be associated to a specific value transfer

token

{
  "token": "0b16eb77-f4a6-456a-a87b-dda974060665"
}

Properties

Name Type Required Restrictions Description
token string false none Access token

encryptedPayload

{
  "encryptedPayload": "string"
}

Properties

Name Type Required Restrictions Description
encryptedPayload string false none Encrypted string

address

{
  "line1": "1900 Sesame Street",
  "line2": "Suite 400",
  "locality": "New York",
  "region": "NY",
  "country": "USA",
  "postalCode": "10023"
}

Properties

Name Type Required Restrictions Description
line1 string false none Address line one
line2 string false none Address line two
locality string false none City, Suburb, Town, Locality
region string false none Departments, States, Provinces, Counties
country string false none Country of the user
postalCode string false none Postal code of the user

customFields

{
  "customField1": "string",
  "customField2": "string",
  "customField3": "string",
  "customField4": "string",
  "customField5": "string"
}

Custom Fields that can be associated to a specific object

Properties

Name Type Required Restrictions Description
customField1 string false none User-specific field
customField2 string false none User-specific field
customField3 string false none User-specific field
customField4 string false none User-specific field
customField5 string false none User-specific field

balance

{
  "balance": 0
}

Balance response

Properties

Name Type Required Restrictions Description
balance number false none The balance of the requested record

status

{
  "status": 0
}

Status response

Properties

Name Type Required Restrictions Description
status number false none The status of the requested record
Shell HTTP JavaScript Ruby Python PHP Java Go