Prepaid Token API

Request Parameters

Parameter	Description	Required
`addressName` `addressLine1` `addressLine2` `city` `state` `zip` `phoneNumber`	The sender's shipping address. You might choose to collect the address on your web site and pass it to the CBUI. If you choose to collect the shipping address yourself, you can use these parameters to specify it. This address will be displayed to the sender on the payment authorization confirmation page. See also the description of `collectShippingAddress`. Type: String Default: None	No
`callerReferenceFunding`	Unique identifier you supply to specify this payment token and its funding in your records. Type: String Constraint: Max size = 128 bytes	Yes
`callerReferenceSender`	Unique identifier you supply to specify this payment token and the sender in your records. Type: String Constraint: Max size = 128 bytes	Yes
`collectShippingAddress`	If you set this value to `True`, all the shipping address parameters (`addressName`, `addressLine1`, etc.) are ignored, and the shipping/mailing address that the sender confirms on the CBUI pages is returned as part of the return URL. Type: Boolean Default: `False` Valid Values: `True` \| `False`	No
`currencyCode`	Specifies the currency of all amounts that this pipeline accepts. Type: String Default: `USD` Valid Values: `USD`	No
`fundingAmount`	Specifies the maximum amount the prepaid balance can be. Type: String	Yes
`paymentMethod`	Specifies payment methods the recipient supports. Use `CC` for credit cards, `ACH` for bank account withdrawal, and `ABT` for Amazon Payments balance transfer. Type: Comma-separated list Default: `ABT` Valid Values: `CC` \| `ACH` \| `ABT`	No
`paymentReason`	Specifies the reason for this payment transaction. You can provide a limited set of HTML tags to format your text, including <b>, <i>, <u>, <ul>, <li>, <br>, <em>, <strong>, and <strike>. Other tags are ignored. Type: String	No
`validityExpiry`	When the token expires. The expiry date has no restrictions, other than the date cannot be earlier than the current date. Type: Date Default: No expiration	No
`validityStart`	When the token becomes valid. By default this date is current date. Provides seconds unit using the EPOCH time. Type: Date Default: The current date Constraint: The validity start date should be within one year from the current date. The date cannot be beyond one year or earlier than the current date.	No

The request also uses the parameters common to all Co-Branded service API requests. For more information, see Common Parameters.

Response Parameters

Parameter	Description
`addressName` `addressLine1` `addressLine2` `city` `state` `zip` `phoneNumber`	The sender's shipping address. These parameters are returned only if `collectShippingAddress` was set to `True` in the request. Type: String
`errorMessage`	This is text in a human readable form that specifies the reason for a request failure. Type: String
`expiry`	Specifies the expiry (if any) of the payment method. Type: String
`fundingTokenID`	This is the token used to fund the prepaid balance. Type: String
`prepaidInstrumentID`	This is the prepaid instrument associated with a prepaid balance. Type: String
`prepaidSenderTokenID`	This is the token that allows you to use the prepaid balance. Type: String
`status`	The status of the Co-Branded service request. Type: String Valid Values: See Status Codes.
`warningCode`	There might be cases when the sender token is installed successfully but there is an associated warning. This parameter denotes that warning. Type: String Valid Values: `invalidShippingAddress` (returned when you pass an incorrect shipping address in the request parameters `addressLine1`, `addressLine2`, `city`, etc.)
`warningMessage`	Specifies a human readable text that explains the warning corresponding to the `warningCode`. Type: String

Responses also include parameters common to all responses. For more information, see Response Parameters.

Status Codes

The following table describes the valid values for the status parameter.

Status Code	Description
SA	Success status for the ABT payment method.
SB	Success status for the ACH (bank account) payment method.
SC	Success status for the credit card payment method.
SE	System error.
A	Buyer abandoned the pipeline.
CE	Specifies a caller exception.
PE	Payment Method Mismatch Error: Specifies that the user does not have payment method that you have requested.
NP	This account type does not support the specified payment method.
NM	You are not registered as a third-party caller to make this transaction. Contact Amazon Payments for more information.