v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Actors

Update Actor's Payment Methods

Updates the payment methods associated with a specific actor, identified by the ActorID.

put/v1/actors/{ActorID}/paymentMethods

Path parameters

ActorIDinteger required

The unique identifier of the actor whose payment methods are being updated.

Request body

ActorIDinteger

The unique identifier of the actor.

PaymentMethodIDinteger

The identifier of the payment method associated with the actor.

ExtraChargePercentageBitboolean nullable

Indicates whether an extra charge is calculated as a percentage of the transaction.

ExtraChargeValuenumber double

The value of the extra charge applied to transactions.

LastUpdatedstring date-time nullable

The date and time when the payment method details were last updated.

ExternalPaymentProviderURLstring nullable

The URL of the external payment provider, if applicable.

ExternalPaymentProviderIDinteger nullable

The identifier of the external payment provider.

ExternalPaymentProviderModeIDinteger nullable

The mode identifier of the external payment provider (e.g., test, production).

ExternalPaymentProviderUsernamestring nullable

The username used for authentication with the external payment provider.

ExternalPaymentProviderPasswordstring nullable

The password used for authentication with the external payment provider.

ExternalPaymentProviderMerchantIDstring nullable

The merchant identifier used by the external payment provider.

ExternalPaymentProviderKeystring nullable

The key used by the external payment provider for transaction processing.

ExternalPaymentProviderAppIDstring nullable

The application identifier used by the external payment provider.

ExternalPaymentProviderCertificatePathstring nullable

The file path to the certificate used by the external payment provider.

ExternalPaymentProviderCertificatePasswordstring nullable

The password for the external payment provider's certificate.

ExternalPaymentProviderApiKeystring nullable

The API key used by the external payment provider.

ExternalPaymentProviderLocationIdentifierstring nullable

The location identifier used by the external payment provider.

PaymentMethodCustomDatastring nullable

Custom data associated with the payment method, if any.

ExtraChargeBackupValuenumber double

The backup value of the extra charge applied to transactions.

ChargeMachineIDinteger nullable

The identifier of the machine where charges are processed, if applicable.

Response

The payment methods were updated successfully.

ActorIDinteger

The unique identifier of the actor.

PaymentMethodIDinteger

The identifier of the payment method associated with the actor.

ExtraChargePercentageBitboolean nullable

Indicates whether an extra charge is calculated as a percentage of the transaction.

ExtraChargeValuenumber double

The value of the extra charge applied to transactions.

LastUpdatedstring date-time nullable

The date and time when the payment method details were last updated.

ExternalPaymentProviderURLstring nullable

The URL of the external payment provider, if applicable.

ExternalPaymentProviderIDinteger nullable

The identifier of the external payment provider.

ExternalPaymentProviderModeIDinteger nullable

The mode identifier of the external payment provider (e.g., test, production).

ExternalPaymentProviderUsernamestring nullable

The username used for authentication with the external payment provider.

ExternalPaymentProviderPasswordstring nullable

The password used for authentication with the external payment provider.

ExternalPaymentProviderMerchantIDstring nullable

The merchant identifier used by the external payment provider.

ExternalPaymentProviderKeystring nullable

The key used by the external payment provider for transaction processing.

ExternalPaymentProviderAppIDstring nullable

The application identifier used by the external payment provider.

ExternalPaymentProviderCertificatePathstring nullable

The file path to the certificate used by the external payment provider.

ExternalPaymentProviderCertificatePasswordstring nullable

The password for the external payment provider's certificate.

ExternalPaymentProviderApiKeystring nullable

The API key used by the external payment provider.

ExternalPaymentProviderLocationIdentifierstring nullable

The location identifier used by the external payment provider.

PaymentMethodCustomDatastring nullable

Custom data associated with the payment method, if any.

ExtraChargeBackupValuenumber double

The backup value of the extra charge applied to transactions.

ChargeMachineIDinteger nullable

The identifier of the machine where charges are processed, if applicable.