Back to Index

POST v1/FundsTransfers

Transfers funds between a peloton account and a bank account

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The funds_transfer_request which describes the transaction

funds_transfer_request
NameDescriptionTypeAdditional information
amount

The amount to be transferred between accounts. Must be positive.

decimal number

Required

transfer_system

The system used to facilitate the transfer

string

Required

Matching regular expression pattern: EFT|ACH

String length: inclusive between 0 and 3

bank_account_token

The token used to identify the bank account

string

Required

String length: inclusive between 32 and 32

account_token

The token used to identify the Peloton account

string

Required

String length: inclusive between 32 and 32

transfer_date

The date the transfer is scheduled to occur. This will default to the current UTC DateTime. If past dates are supplied the current UTC DateTime will be used. If a future UTC DateTime is provided, the transfer will be scheduled for processing on the future date

date

None.

type

The type of transfer

string

Matching regular expression pattern: CREDIT|DEBIT

references

Additional information to record with the transfer request

Collection of reference

None.

application_name

The name of the calling application

string

Required

String length: inclusive between 0 and 128

language_code

Determines the Language of the response data. 2 Character ISO LanguageCode. Supported language codes are: 'en' (English), 'fr' (French). Default is 'en'.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "amount": 1.0,
  "transfer_system": "sample string 1",
  "bank_account_token": "sample string 2",
  "account_token": "sample string 3",
  "transfer_date": "2019-01-23T16:23:15.363072-08:00",
  "type": "sample string 4",
  "references": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "application_name": "sample string 5",
  "language_code": "en"
}

Response Information

Resource Description

transaction_response
NameDescriptionTypeAdditional information
transaction_ref_code

This field will return a value for any transaction that occurs, otherwise will be empty.

string

String length: inclusive between 0 and 36

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "transaction_ref_code": "sample string 1",
  "success": true,
  "message": "sample string 3",
  "message_code": 4,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}