NAV

getPaymentForm

POST /v2/invoice/payment_form

Whenever you would like to trigger a payment form in your internal business management system, use this method. This method comes in handy when you would like to charge your customers right from your office if they do not have their devices on them.

Parameters
Name
Description
paymentSettingsModel (required)
Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "allow_card_preauthorized": true,
    "allow_card_save": true,
    "company_id": 0,
    "creation_date": "string",
    "iframe_width": "string",
    "invoice_id": "string",
    "locale": "string",
    "payment_methods": [
        "CREDIT_CARD",
        "BANK_ACCOUNT",
        "WE_CHAT_PAY",
        "ALI_PAY"
    ],
    "redirect_url_error": "string",
    "redirect_url_success": "string",
    "send_payment_confirmation": true,
    "show_banks_saved": true,
    "show_cards_saved": true,
    "show_download_invoice": true,
    "show_download_receipt": true,
    "uuid": "string"
}
             
          
{ } PaymentSettingsModel
allow_card_preauthorized (optional) boolean
allow_card_save (optional) boolean
company_id (optional) integer
creation_date (optional) string
iframe_width (optional) string
invoice_id (optional) string
locale (optional) string
payment_methods (optional) array
redirect_url_error (optional) string
redirect_url_success (optional) string
send_payment_confirmation (optional) boolean
show_banks_saved (optional) boolean
show_cards_saved (optional) boolean
show_download_invoice (optional) boolean
show_download_receipt (optional) boolean
uuid (optional) string
             {
    "url": "string"
}
             
          
{ } PaymentFormModel
url (optional) string
             <payment_settings_model>
  <allow_card_preauthorized>1</allow_card_preauthorized>
  <allow_card_save>1</allow_card_save>
  <company_id>0</company_id>
  <creation_date>string</creation_date>
  <iframe_width>string</iframe_width>
  <invoice_id>string</invoice_id>
  <locale>string</locale>
  <payment_methods/>
  <redirect_url_error>string</redirect_url_error>
  <redirect_url_success>string</redirect_url_success>
  <send_payment_confirmation>1</send_payment_confirmation>
  <show_banks_saved>1</show_banks_saved>
  <show_cards_saved>1</show_cards_saved>
  <show_download_invoice>1</show_download_invoice>
  <show_download_receipt>1</show_download_receipt>
  <uuid>string</uuid>
</payment_settings_model>

             
          
{ } PaymentSettingsModel
allow_card_preauthorized (optional) boolean
allow_card_save (optional) boolean
company_id (optional) integer
creation_date (optional) string
iframe_width (optional) string
invoice_id (optional) string
locale (optional) string
payment_methods (optional) array
redirect_url_error (optional) string
redirect_url_success (optional) string
send_payment_confirmation (optional) boolean
show_banks_saved (optional) boolean
show_cards_saved (optional) boolean
show_download_invoice (optional) boolean
show_download_receipt (optional) boolean
uuid (optional) string
             <payment_form_model>
  <url>string</url>
</payment_form_model>

             
          
{ } PaymentFormModel
url (optional) string