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.
| Parameter | Description | Type | Constraints |
|---|---|---|---|
|
|
Specifies a set of rules in the GateKeeper language format to be installed on the caller's account. |
String |
Required |
|
|
Specifies a human-friendly, readable name for the payment instruction. |
String Max size = 128 characters |
Optional |
|
|
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 |
|
|
Specifies one of the following token types:
|
Required | |
|
|
Specifies the reason for making the payment. |
String Max size = 64 characters |
Optional |
| Element | Description | Type | Availability | |||
|---|---|---|---|---|---|---|
| A 64-character alphanumeric string that represents the installed payment instruction. | TokenId | Returned only if the payment instruction is installed successfully. | |||
| Provides the status of the request | Always returned | ||||
| Contains an error code that describes the reason for the failure of the request | ServiceErrors | Returned only if status=failure | |||
| 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 | |||