payment-methods

Payment Method

put/v3.0/payment-methods/{slug}/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/payment-methods/{slug}/
  • Auth: none declared. Required headers: x-api-key

Path parameters

slugstring required

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Request body

titlestring

payment method's display name.

gateway'stripe' | 'paypal' | 'square' | 'razorpay' required
logostring binary

payment method's logo.

descriptionstring nullable

any extra description to show with payment method.

activeboolean

shows whether the method is currently active.

terminal_codestring nullable

the terminal code needed to connect to the gateway.

merchant_codestring nullable

the merchant code needed to connect to the gateway.

webhook_idstring nullable

auto-created webhook's id for the payment methods that need it (e.g. Stripe).

private_keystring nullable

the private key needed to sign the payment data.

orderinteger

shows payment method ordering.

Response

created_atstring date-time
updated_atstring date-time
titlestring

payment method's display name.

namestring

payment method's identifying name.

gateway'stripe' | 'paypal' | 'square' | 'razorpay' required
payment_type'offline' | 'gateway'
logostring uri

payment method's logo.

descriptionstring nullable

any extra description to show with payment method.

activeboolean

shows whether the method is currently active.

terminal_codestring nullable

the terminal code needed to connect to the gateway.

merchant_codestring nullable

the merchant code needed to connect to the gateway.

webhook_idstring nullable

auto-created webhook's id for the payment methods that need it (e.g. Stripe).

private_keystring nullable

the private key needed to sign the payment data.

orderinteger

shows payment method ordering.

Changes

No recorded changes to this operation across all 1 revision of this API.