Create Actor's Payment Methods

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/actors/{ActorID}/paymentMethods \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "ActorID": 123,
    "PaymentMethodID": 123,
    "ExtraChargePercentageBit": true,
    "ExtraChargeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderURL": "<string>",
    "ExternalPaymentProviderID": 123,
    "ExternalPaymentProviderModeID": 123,
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderMerchantID": "<string>",
    "ExternalPaymentProviderKey": "<string>",
    "ExternalPaymentProviderAppID": "<string>",
    "ExternalPaymentProviderCertificatePath": "<string>",
    "ExternalPaymentProviderCertificatePassword": "<string>",
    "ExternalPaymentProviderApiKey": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ExtraChargeBackupValue": 123,
    "ChargeMachineID": 123
  }
]
'

[
  {
    "ActorID": 123,
    "PaymentMethodID": 123,
    "ExtraChargePercentageBit": true,
    "ExtraChargeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderURL": "<string>",
    "ExternalPaymentProviderID": 123,
    "ExternalPaymentProviderModeID": 123,
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderMerchantID": "<string>",
    "ExternalPaymentProviderKey": "<string>",
    "ExternalPaymentProviderAppID": "<string>",
    "ExternalPaymentProviderCertificatePath": "<string>",
    "ExternalPaymentProviderCertificatePassword": "<string>",
    "ExternalPaymentProviderApiKey": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ExtraChargeBackupValue": 123,
    "ChargeMachineID": 123
  }
]

POST

actors

{ActorID}

paymentMethods

Create Actor's Payment Methods

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/actors/{ActorID}/paymentMethods \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "ActorID": 123,
    "PaymentMethodID": 123,
    "ExtraChargePercentageBit": true,
    "ExtraChargeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderURL": "<string>",
    "ExternalPaymentProviderID": 123,
    "ExternalPaymentProviderModeID": 123,
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderMerchantID": "<string>",
    "ExternalPaymentProviderKey": "<string>",
    "ExternalPaymentProviderAppID": "<string>",
    "ExternalPaymentProviderCertificatePath": "<string>",
    "ExternalPaymentProviderCertificatePassword": "<string>",
    "ExternalPaymentProviderApiKey": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ExtraChargeBackupValue": 123,
    "ChargeMachineID": 123
  }
]
'

[
  {
    "ActorID": 123,
    "PaymentMethodID": 123,
    "ExtraChargePercentageBit": true,
    "ExtraChargeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderURL": "<string>",
    "ExternalPaymentProviderID": 123,
    "ExternalPaymentProviderModeID": 123,
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderMerchantID": "<string>",
    "ExternalPaymentProviderKey": "<string>",
    "ExternalPaymentProviderAppID": "<string>",
    "ExternalPaymentProviderCertificatePath": "<string>",
    "ExternalPaymentProviderCertificatePassword": "<string>",
    "ExternalPaymentProviderApiKey": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ExtraChargeBackupValue": 123,
    "ChargeMachineID": 123
  }
]

Authorizations

Authorization

string

header

required

Enter your API key. It's required to authenticate API requests.

Path Parameters

ActorID

integer<int64>

required

The unique identifier of the actor for whom the payment methods are being created.

Body

application/json

The payment methods to be created

ActorID

integer<int64>

The unique identifier of the actor.

PaymentMethodID

integer<int32>

The identifier of the payment method associated with the actor.

ExtraChargePercentageBit

boolean | null

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

ExtraChargeValue

number<double>

The value of the extra charge applied to transactions.

LastUpdated

string<date-time> | null

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

ExternalPaymentProviderURL

string | null

The URL of the external payment provider, if applicable.

ExternalPaymentProviderID

integer<int32> | null

The identifier of the external payment provider.

ExternalPaymentProviderModeID

integer<int32> | null

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

ExternalPaymentProviderUsername

string | null

The username used for authentication with the external payment provider.

ExternalPaymentProviderPassword

string | null

The password used for authentication with the external payment provider.

ExternalPaymentProviderMerchantID

string | null

The merchant identifier used by the external payment provider.

ExternalPaymentProviderKey

string | null

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

ExternalPaymentProviderAppID

string | null

The application identifier used by the external payment provider.

ExternalPaymentProviderCertificatePath

string | null

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

ExternalPaymentProviderCertificatePassword

string | null

The password for the external payment provider's certificate.

ExternalPaymentProviderApiKey

string | null

The API key used by the external payment provider.

ExternalPaymentProviderLocationIdentifier

string | null

The location identifier used by the external payment provider.

PaymentMethodWorkingDays

object[] | null

The working days and hours during which the payment method is available.

Show child attributes

PaymentMethodCustomData

string | null

Custom data associated with the payment method, if any.

ExtraChargeBackupValue

number<double>

The backup value of the extra charge applied to transactions.

ChargeMachineID

integer<int64> | null

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

Response

200 - application/json

The payment methods were created successfully.

ActorID

integer<int64>

The unique identifier of the actor.

PaymentMethodID

integer<int32>

The identifier of the payment method associated with the actor.

ExtraChargePercentageBit

boolean | null

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

ExtraChargeValue

number<double>

The value of the extra charge applied to transactions.

LastUpdated

string<date-time> | null

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

ExternalPaymentProviderURL

string | null

The URL of the external payment provider, if applicable.

ExternalPaymentProviderID

integer<int32> | null

The identifier of the external payment provider.

ExternalPaymentProviderModeID

integer<int32> | null

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

ExternalPaymentProviderUsername

string | null

The username used for authentication with the external payment provider.

ExternalPaymentProviderPassword

string | null

The password used for authentication with the external payment provider.

ExternalPaymentProviderMerchantID

string | null

The merchant identifier used by the external payment provider.

ExternalPaymentProviderKey

string | null

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

ExternalPaymentProviderAppID

string | null

The application identifier used by the external payment provider.

ExternalPaymentProviderCertificatePath

string | null

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

ExternalPaymentProviderCertificatePassword

string | null

The password for the external payment provider's certificate.

ExternalPaymentProviderApiKey

string | null

The API key used by the external payment provider.

ExternalPaymentProviderLocationIdentifier

string | null

The location identifier used by the external payment provider.

PaymentMethodWorkingDays

object[] | null

The working days and hours during which the payment method is available.

Show child attributes

PaymentMethodCustomData

string | null

Custom data associated with the payment method, if any.

ExtraChargeBackupValue

number<double>

The backup value of the extra charge applied to transactions.

ChargeMachineID

integer<int64> | null

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

Update Actor's Payment Methods Delete a Payment Method

⌘I

Guides

API Reference

Create Actor's Payment Methods

Authorizations

Path Parameters

Body

Response