Skip to main content

Create transfer

Action: POST Endpoint: /v3/moneymovement/transfers Transfers funds using an external card.

Request body

FieldsDescription
token

string

Optional
Unique identifier for the transfer to be created.

Allowable Values:

36 char max
transfer_type

string

Required
Type of transfer to perform.

Allowable Values:

CARD_PULL, CARD_PUSH, CARD_DISBURSEMENT
card_token

string

Required
Unique identifier of the external card involved in the transfer.

Allowable Values:

Existing card token
amount

decimal

Required
Amount of transfer.

Allowable Values:

Any number between 1 and 1000000000
currency

string

Required
A valid three-digit ISO 4217 currency code.

Allowable Values:

3 chars
statement_descriptor

string

Optional
Description of the transaction, as it will appear on the recipient’s bank statement.

Allowable Values:

22 char max

Sample request body

Card push transfer with user token
JSON
{
  "transfer_type": "CARD_PUSH",
  "card_token": "ext_card_12345",
  "source_user_token": "user_67890",
  "amount": 100.5,
  "currency": "USD",
  "statement_descriptor": "GROCERY STORE"
}
Card push transfer with business token
JSON
{
  "transfer_type": "CARD_PUSH",
  "card_token": "ext_card_12345",
  "source_business_token": "business_67890",
  "amount": 250,
  "currency": "USD",
  "statement_descriptor": "ACME CORP PAYROLL"
}
Card push transfer without tokens (for cards with an associated account)
JSON
{
  "transfer_type": "CARD_PUSH",
  "card_token": "ext_card_12345",
  "amount": 150,
  "currency": "USD",
  "statement_descriptor": "COFFEE SHOP"
}
Card pull transfer with user token
JSON
{
  "transfer_type": "CARD_PULL",
  "card_token": "ext_card_12345",
  "destination_user_token": "user_67890",
  "amount": 75.25,
  "currency": "USD",
  "statement_descriptor": "WALLET FUNDING"
}
Card pull transfer with business token
JSON
{
  "transfer_type": "CARD_PULL",
  "card_token": "ext_card_12345",
  "destination_business_token": "business_67890",
  "amount": 500,
  "currency": "USD",
  "statement_descriptor": "VENDOR PAYMENT"
}
Card pull transfer without tokens (for cards with an associated account)
JSON
{
  "transfer_type": "CARD_PULL",
  "card_token": "ext_card_12345",
  "amount": 200,
  "currency": "USD",
  "statement_descriptor": "GAS STATION"
}
Card disbursement transfer
JSON
{
  "transfer_type": "CARD_DISBURSEMENT",
  "card_token": "ext_card_12345",
  "amount": 1000,
  "currency": "USD",
  "statement_descriptor": "CASHBACK REWARD"
}

Response body

FieldsDescription
token

string

Conditionally returned
Unique identifier of the transfer.

Allowable Values:

36 char max
transfer_type

string

Conditionally returned
Type of transfer to perform.

Allowable Values:

CARD_PULL, CARD_PUSH, CARD_DISBURSEMENT
card_token

string

Conditionally returned
Unique identifier of the external card involved in the transfer.

Allowable Values:

36 char max
source_user_token

string

Conditionally returned
User token that is the source for the transfer.

Allowable Values:

36 char max
source_business_token

string

Conditionally returned
Business token that is the source for the transfer.

Allowable Values:

36 char max
destination_user_token

string

Conditionally returned
User token that is the destination for the transfer.

Allowable Values:

36 char max
destination_business_token

string

Conditionally returned
Business token that is the destination for the transfer.

Allowable Values:

36 char max
amount

decimal

Conditionally returned
Amount of the transfer.

Allowable Values:

Any number between 1 and 1000000000
currency

string

Conditionally returned
Currency of the transfer.

Allowable Values:

A valid three-digit ISO 4217 currency code
statement_descriptor

string

Conditionally returned
Description of the transaction, as it will appear on the recipient’s bank statement.

Allowable Values:

22 char max
status

string

Conditionally returned
Processing state of the transaction.

Allowable Values:

COMPLETE
created_time

datetime

Conditionally returned
Date and time when the transfer was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
last_modified_time

datetime

Conditionally returned
Date and time when the transfer was updated, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

List transfers for an account holder

Action: GET Endpoint: /v3/moneymovement/transfers/accountholders/{account_holder_token} Returns a paginated list of transfers for a specific account holder.

URL path parameters

FieldsDescription
account_holder_token

string

Required
Unique identifier of the account holder (user or business).

Allowable Values:

Valid account holder token

URL query parameters

FieldsDescription
count

integer

Optional
Number of transfers to return.

Allowable Values:

1–50
start_index

integer

Optional
Sort order index of the first resource in the returned array.

Allowable Values:

0 min

Response body

FieldsDescription
count

integer

Conditionally returned
Number of transfer resources to retrieve.

Allowable Values:

1-10
start_index

integer

Conditionally returned
Sort order index of the first resource in the returned array.

Allowable Values:

Any integer
end_index

integer

Conditionally returned
Sort order index of the last resource in the returned array.

Allowable Values:

Any integer
is_more

boolean

Conditionally returned
A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false
data

array of objects

Conditionally returned
Array of transfer objects.

Allowable Values:

Valid array of transfer objects
data[].token

string

Conditionally returned
Unique identifier of the transfer.

Allowable Values:

36 char max
data[].transfer_type

string

Conditionally returned
Type of transfer to perform.

Allowable Values:

CARD_PULL, CARD_PUSH, CARD_DISBURSEMENT
data[].card_token

string

Conditionally returned
Unique identifier of the external card involved in the transfer.

Allowable Values:

36 char max
data[].source_user_token

string

Conditionally returned
User token that is the source for the transfer.

Allowable Values:

36 char max
data[].source_business_token

string

Conditionally returned
Business token that is the source for the transfer.

Allowable Values:

36 char max
data[].destination_user_token

string

Conditionally returned
User token that is the destination for the transfer.

Allowable Values:

36 char max
data[].destination_business_token

string

Conditionally returned
Business token that is the destination for the transfer.

Allowable Values:

36 char max
data[].amount

decimal

Conditionally returned
Amount of the transfer.

Allowable Values:

Any number between 1 and 1000000000
data[].currency

string

Conditionally returned
Currency of the transfer.

Allowable Values:

A valid three-digit ISO 4217 currency code
data[].statement_descriptor

string

Conditionally returned
Description of the transaction, as it will appear on the recipient’s bank statement.

Allowable Values:

22 char max
data[].status

string

Conditionally returned
Processing state of the transaction.

Allowable Values:

COMPLETE
data[].created_time

datetime

Conditionally returned
Date and time when the transfer was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
data[].last_modified_time

datetime

Conditionally returned
Date and time when the transfer was updated, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Retrieve transfer

Action: GET Endpoint: /v3/moneymovement/transfers/{token} Retrieves a transfer using the specified transfer token.

URL path parameters

FieldsDescription
token

string

Required
Transfer token that was returned by POST /transfers when the transfer was created.

Allowable Values:

Valid transfer token

Response body

FieldsDescription
token

string

Conditionally returned
Unique identifier of the transfer.

Allowable Values:

36 char max
transfer_type

string

Conditionally returned
Type of transfer to perform.

Allowable Values:

CARD_PULL, CARD_PUSH, CARD_DISBURSEMENT
card_token

string

Conditionally returned
Unique identifier of the external card involved in the transfer.

Allowable Values:

36 char max
source_user_token

string

Conditionally returned
User token that is the source for the transfer.

Allowable Values:

36 char max
source_business_token

string

Conditionally returned
Business token that is the source for the transfer.

Allowable Values:

36 char max
destination_user_token

string

Conditionally returned
User token that is the destination for the transfer.

Allowable Values:

36 char max
destination_business_token

string

Conditionally returned
Business token that is the destination for the transfer.

Allowable Values:

36 char max
amount

decimal

Conditionally returned
Amount of the transfer.

Allowable Values:

Any number between 1 and 1000000000
currency

string

Conditionally returned
Currency of the transfer.

Allowable Values:

A valid three-digit ISO 4217 currency code
statement_descriptor

string

Conditionally returned
Description of the transaction, as it will appear on the recipient’s bank statement.

Allowable Values:

22 char max
status

string

Conditionally returned
Processing state of the transaction.

Allowable Values:

COMPLETE
created_time

datetime

Conditionally returned
Date and time when the transfer was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
last_modified_time

datetime

Conditionally returned
Date and time when the transfer was updated, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ