Sign in

v1

latestOpenAPI 3.0.32026-07-2476126451.9 KB
v1.1

List payment Methods

Get a list of available payment methods associated with a specific account based on the currency.

post/api/v1.4/accounts/payment_methods/

Request body

currencystring required

The currency of the amount represented by a string of alphabetic code from ISO 4217 Currency codes

amountstring decimal

The amount to charge. The field must have no more than 14 total digits and no more than 2 decimal places.

flow_idstring

Published flow id that should be followed for this intent

customerstring uuid

The customer id to list all customer saved cards and wallets

operation'blocked' | 'purchase' | 'authorize' | 'capture' | 'refund' | 'void' | 'increase_authorization' | 'increase_purchase_amount' | 'decrease_purchase_amount' | 'wallet_credit' | 'wallet_debit' | 'increase_amount' | 'decrease_amount' | 'disburse' | 'BLOCKED' | 'PURCHASE' | 'AUTHORIZE' | 'CAPTURE' | 'REFUND' | 'VOID' | 'INCREASE_AUTHORIZATION' | 'INCREASE_PURCHASE_AMOUNT' | 'DECREASE_PURCHASE_AMOUNT' | 'WALLET_CREDIT' | 'WALLET_DEBIT' | 'INCREASE_AMOUNT' | 'DECREASE_AMOUNT' | 'DISBURSE'

The operation that you would like to list the methods for, it could be either purchase or authorize. If not provided, it will default to purchase.

  • blocked - blocked
  • purchase - purchase
  • authorize - authorize
  • capture - capture
  • refund - refund
  • void - void
  • increase_authorization - increase_authorization
  • increase_purchase_amount - increase_purchase_amount
  • decrease_purchase_amount - decrease_purchase_amount
  • wallet_credit - wallet_credit
  • wallet_debit - wallet_debit
  • increase_amount - increase_amount
  • decrease_amount - decrease_amount
  • disburse - disburse
  • BLOCKED - BLOCKED
  • PURCHASE - PURCHASE
  • AUTHORIZE - AUTHORIZE
  • CAPTURE - CAPTURE
  • REFUND - REFUND
  • VOID - VOID
  • INCREASE_AUTHORIZATION - INCREASE_AUTHORIZATION
  • INCREASE_PURCHASE_AMOUNT - INCREASE_PURCHASE_AMOUNT
  • DECREASE_PURCHASE_AMOUNT - DECREASE_PURCHASE_AMOUNT
  • WALLET_CREDIT - WALLET_CREDIT
  • WALLET_DEBIT - WALLET_DEBIT
  • INCREASE_AMOUNT - INCREASE_AMOUNT
  • DECREASE_AMOUNT - DECREASE_AMOUNT
  • DISBURSE - DISBURSE
default_evaluation_for_needed_fieldsboolean

A boolean flag indicating whether to evaluate default values from the dynamic checkout triggers.

{"stackTrail":"components:schemas:PaymentMethodOption:properties:custom_fields","oasType":"schema","type":"unknown","description":"Key value pairs of any additional information you want with the payment."}
ip_addressstring

The IP address of the user who is making the payment.

user_agentstring

The user agent of the user who is making the payment.

vault_region'sa' | 'default' | ''
  • sa - sa
  • default - default
get_billing_fieldsboolean

A boolean flag indicating whether to get the billing fields for the payment methods.

Response

countinteger nullable required

Total number of items.

nextstring nullable required

Next page url if exists

previousstring nullable required

Previous page url if exists