Transfers funds between peloton accounts
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
The transfer_request which describes the transaction
transfer_requestName | Description | Type | Additional information |
---|---|---|---|
amount |
The amount to be transferred between accounts. Must be positive. |
decimal number |
Required |
source_account_token |
The token identifying the account to be debited |
string |
Required String length: inclusive between 32 and 32 |
target_account_token |
The token identifying the account to be credited |
string |
Required String length: inclusive between 32 and 32 |
auto_accept |
If enabled, the transfer will be automatically accepted in the target account |
boolean |
Required |
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. |
{ "amount": 1.0, "source_account_token": "sample string 1", "target_account_token": "sample string 2", "auto_accept": true, "references": [ { "name": "sample string 1", "value": "sample string 2" }, { "name": "sample string 1", "value": "sample string 2" } ], "application_name": "sample string 3", "language_code": "en" }
Name | Description | Type | Additional 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. |
{ "transaction_ref_code": "sample string 1", "success": true, "message": "sample string 3", "message_code": 4, "errors": [ "sample string 1", "sample string 2" ] }