Back to Index

DELETE v1/FundsTransfers

Cancel a funds transfer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The funds_transfer_delete_request which describes the transaction

funds_transfer_delete_request
NameDescriptionTypeAdditional information
transaction_ref_code

The transaction reference code provided when creating the funds transfer.

string

String length: inclusive between 0 and 32

comment

Optional: A comment giving a reason for the cancellation

string

String length: inclusive between 0 and 128

account_token

The token used to identify the Peloton account

string

Required

String length: inclusive between 32 and 32

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:
{
  "transaction_ref_code": "sample string 1",
  "comment": "sample string 2",
  "account_token": "sample string 3",
  "application_name": "sample string 4",
  "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"
  ]
}