api
customer-payment-methods

Changed on

Get payment methods for customer

get/api/customers/{id}/payment-methods

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/customers/{id}/payment-methods
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

ID of the customer

Query parameters

channelstring

Channel the methods are used for

primaryboolean

Whether the payment method is primary or not

activeboolean

Whether the payment method is active or not

gatewayIdstring

The ID of the payment gateway or additional payment method which the payment method belongs to

paymentGatewayChannelsstring[]

The allowed payment gateway channels

statusstring[]

Response

OK

_idstring required

The ID of the payment method

status'ACTIVE' | 'DELETED' | 'EXPIRED' required

The status of the payment method

sellerIdstring required

The ID of the seller this payment method

dataobject

Whether the payment method is primary

paymentDetailsobject

Whether the payment method is primary

primaryboolean required

Whether the payment method is primary

activeboolean required

Whether the payment method is primary

gatewayType'stripe' | 'paypal' | 'adyen' | 'custom' | 'cardconnect' | 'worldline' | 'shift4' | 'authorizenet' | 'wallee' | 'square' | 'payfast' | 'touchnet' | 'transact' | 'unzer' | 'monext' | 'vivenuPayments' | 'ebanx' | 'rapyd' | 'momentusPayments' | 'paymob' | 'additional-payment-method'

The type of the payment gateway associated to this method

gatewayIdstring required

The ID of the attached payment gateway or additional payment method

createdAtstring date-time

The created ISO timestamp

updatedAtstring date-time

The last updated ISO timestamp

Changes

  • a18eefe17b94Revision changes
    • warning

      added the new paymob enum value to the / response property for the response status

  • 9155568e45b2Revision changes
    • warning

      added the new momentusPayments enum value to the / response property for the response status