Payments / Paginator / ListPaymentInstruments
ListPaymentInstruments¶
- class Payments.Paginator.ListPaymentInstruments¶
paginator = client.get_paginator('list_payment_instruments')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
Payments.Client.list_payment_instruments().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'paymentInstrumentSummaries': [ { 'id': 'string', 'arn': 'string', 'paymentMethod': 'CARD'|'US_ACH_BANK_ACCOUNT'|'SEPA_BANK_ACCOUNT'|'UK_BACS_BANK_ACCOUNT'|'IN_NET_BANKING'|'CN_BANK_REDIRECT'|'UPI'|'PIX'|'PAY_BY_INVOICE', 'status': 'ACTIVE'|'PENDING_SETUP'|'SETUP_IN_PROGRESS'|'INVALID', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
paymentInstrumentSummaries (list) –
The payment instruments on your account, one summary for each instrument. This list is empty when your account has no payment instruments.
(dict) –
A payment instrument as it appears in
ListPaymentInstruments. CallGetPaymentInstrumentfor the full instrument, including the details specific to its payment method such as a card’s last four digits and expiration.id (string) –
The ID of the instrument, unique within your account. It’s the last segment of the instrument’s ARN.
arn (string) –
The Amazon Resource Name (ARN) of the instrument. To allow or deny
GetPaymentInstrumentfor this instrument, use the ARN in theResourceelement of an Amazon Web Services Identity and Access Management (IAM) policy.paymentMethod (string) –
The payment method of the instrument. The following values are valid:
CARD– A credit or debit card.US_ACH_BANK_ACCOUNT– A US bank account debited over Automated Clearing House (ACH).SEPA_BANK_ACCOUNT– A bank account debited over Single Euro Payments Area (SEPA) Direct Debit.UK_BACS_BANK_ACCOUNT– A UK bank account debited over Bacs Direct Debit.IN_NET_BANKING– India net banking. You authorize each payment on your bank’s website.CN_BANK_REDIRECT– China bank redirect. You authorize each payment on your bank’s website.UPI– Unified Payments Interface, the India real-time payment system.PIX– Pix, the Brazilian Central Bank instant payment system.PAY_BY_INVOICE– Pay by invoice. You pay each invoice yourself, for example by bank transfer, instead of Amazon Web Services collecting payment from a card or a bank account.
status (string) –
The current status of the instrument. The following values are valid:
ACTIVE– The instrument is set up, and Amazon Web Services can use it for payments.ACTIVEdoesn’t confirm that the instrument is verified or that a payment with it will succeed. You don’t need to take action.INVALID– Amazon Web Services can’t use the instrument for payments, for example because its Direct Debit or UPI mandate is no longer valid. This status is permanent. The instrument doesn’t return toACTIVE. To pay with this payment method again, add a new payment instrument.PENDING_SETUP– The instrument needs an action from you before Amazon Web Services can use it, such as resuming a paused UPI mandate in your UPI app. Amazon Web Services doesn’t use the instrument for payments until you complete that action.SETUP_IN_PROGRESS– You completed the setup steps, and setup of the instrument is in progress, for example while a Direct Debit or UPI mandate waits for confirmation. Amazon Web Services doesn’t use the instrument for payments until setup is complete. You don’t need to take action.
createdAt (datetime) –
The date and time, in UTC, when the instrument was registered.
updatedAt (datetime) –
The date and time, in UTC, when the instrument was last changed.
NextToken (string) –
A token to resume pagination.