credit_card_token_transaction_request

Request object for creating a credit card transaction when a token is provided in the URL

NameDescriptionTypeAdditional information
order_number

Recommended: Order number provided by the source system, otherwise one will be automatically generated.

string

String length: inclusive between 0 and 50

amount

Total amount to be charged or returned to the customer via this transaction.

decimal number

Required

type

The type of transaction to perform

string

Required

Matching regular expression pattern: VERIFY|PURCHASE|RETURN|AUTHORIZE|COMPLETE

billing_name

The primary billing contact name. Billing_name on record will be used if one is not provided.

string

None.

billing_email_address

The email address for the primary billing contact. Email Address on record will be used if one is not provided.

string

None.

billing_phone_number

The phone number for the primary billing contact. Phone number on record will be used if one is not provided.

string

None.

billing_address

Address for the primary billing contact. Address on record will be used if one is not provided.

address

None.

shipping_name

The name of the shipping contact.

string

None.

shipping_email_address

This email address for the shipping contact.

string

None.

shipping_phone_number

The phone number for the shipping contact.

string

None.

shipping_address

The address for the shipping contact.

address

None.

transaction_ref_code

The transaction reference code provided during the original pre-authorization. Required for types "RETURN|AUTHORIZE|COMPLETE"

string

String length: inclusive between 36 and 36

references

Additional information to record with the transaction request.

Collection of reference

None.

account_token

The token used to identify the Peloton account. Required when more than one account is available.

string

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.