InstallPaymentInstruction

Description

You can use the InstallPaymentInstruction operation to install tokens (payment instructions) on your own accounts.

See the Core Concepts section in the Amazon FPS Getting Started Guide for more information on tokens or payment instructions.

Request Parameters

ParameterDescriptionTypeConstraints

PaymentInstruction

Specifies a set of rules in the GateKeeper language format to be installed on the caller's account.

String

Required

TokenFriendlyName

Specifies a human-friendly, readable name for the payment instruction.

String

Max size = 128 characters

Optional

CallerReference

A unique reference to the payment instructions. This is used to recover or retrieve tokens that are lost or not received after the payment instruction is installed.

String

Max size = 49 characters

Required

TokenType

Specifies one of the following token types:

  • SingleUse

  • MultiUse

  • Recurring

  • Unrestricted

Token Type

Required

PaymentReason

Specifies the reason for making the payment.

String

Max size = 64 characters

Optional

Response Elements

ElementDescriptionTypeAvailability

TokenId

A 64-character alphanumeric string that represents the installed payment instruction.TokenIdReturned only if the payment instruction is installed successfully.

Status

Provides the status of the request

ResponseStatus

Always returned

Errors

Contains an error code that describes the reason for the failure of the request ServiceErrors Returned only if status=failure

RequestId

Amazon FPS returns a request Id for every request. This value is important for debugging purposes. See the RequestId Response Parameter topic for more information about this parameter.

String

Max size = 39 characters

Always returned

Error Condition

Related Operations