SimpleAPI Available versions: 1.0 2.0

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
uuid string (optional)
invoice_id string (optional)
invoice_number string (optional)
locale string (optional)
customer_id string (optional)
paymentSettingsModel (optional)
Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found 
             {
    "allow_card_preauthorized": true,
    "allow_card_save": true,
    "allow_edit_amount": true,
    "amount": 1.01,
    "background_color": "string",
    "company_id": 0,
    "creation_date": "string",
    "customer_id": "string",
    "customer_info_fields": [
        "ACCOUNT_HOLDER",
        "CUSTOMER_ID",
        "CONTRACT",
        "EMAIL",
        "PHONE_NUMBER",
        "ADDRESS",
        "CITY",
        "PROVINCE",
        "ZIP",
        "COUNTRY"
    ],
    "iframe_width": "string",
    "invoice_id": "string",
    "line_item_description": "string",
    "locale": "string",
    "payment_methods": [
        "CREDIT_CARD",
        "BANK_ACCOUNT",
        "CREDIT_CARD_USA",
        "BANK_ACCOUNT_USA"
    ],
    "redirect_type": "INTERNAL",
    "redirect_url_error": "string",
    "redirect_url_success": "string",
    "send_payment_confirmation": true,
    "show_banks_saved": true,
    "show_billing_descriptor": true,
    "show_cards_saved": true,
    "show_customer_info": true,
    "show_download_invoice": true,
    "show_download_receipt": true,
    "show_invoice_info": true,
    "show_thank_label": true,
    "uuid": "string"
}
{ } ApiPaymentSettingsModel
allow_card_preauthorized optional boolean
allow_card_save optional boolean
allow_edit_amount optional boolean
amount optional number
background_color optional string
company_id optional integer
creation_date optional string
customer_id optional string
customer_info_fields optional array
iframe_width optional string
invoice_id optional string
line_item_description optional string
locale optional string
payment_methods optional array
redirect_type optional string
redirect_url_error optional string
redirect_url_success optional string
send_payment_confirmation optional boolean
show_banks_saved optional boolean
show_billing_descriptor optional boolean
show_cards_saved optional boolean
show_customer_info optional boolean
show_download_invoice optional boolean
show_download_receipt optional boolean
show_invoice_info optional boolean
show_thank_label optional boolean
uuid optional string 
             {
    "url": "string"
}
{ } PaymentFormV2Model
url required string 
             <payment_settings_model>
  <allow_card_preauthorized>1</allow_card_preauthorized>
  <allow_card_save>1</allow_card_save>
  <allow_edit_amount>1</allow_edit_amount>
  <amount>1.01</amount>
  <background_color>string</background_color>
  <company_id>0</company_id>
  <creation_date>string</creation_date>
  <customer_id>string</customer_id>
  <customer_info_fields/>
  <iframe_width>string</iframe_width>
  <invoice_id>string</invoice_id>
  <line_item_description>string</line_item_description>
  <locale>string</locale>
  <payment_methods/>
  <redirect_type>INTERNAL</redirect_type>
  <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_billing_descriptor>1</show_billing_descriptor>
  <show_cards_saved>1</show_cards_saved>
  <show_customer_info>1</show_customer_info>
  <show_download_invoice>1</show_download_invoice>
  <show_download_receipt>1</show_download_receipt>
  <show_invoice_info>1</show_invoice_info>
  <show_thank_label>1</show_thank_label>
  <uuid>string</uuid>
</payment_settings_model>
{ } ApiPaymentSettingsModel
allow_card_preauthorized optional boolean
allow_card_save optional boolean
allow_edit_amount optional boolean
amount optional number
background_color optional string
company_id optional integer
creation_date optional string
customer_id optional string
customer_info_fields optional array
iframe_width optional string
invoice_id optional string
line_item_description optional string
locale optional string
payment_methods optional array
redirect_type optional string
redirect_url_error optional string
redirect_url_success optional string
send_payment_confirmation optional boolean
show_banks_saved optional boolean
show_billing_descriptor optional boolean
show_cards_saved optional boolean
show_customer_info optional boolean
show_download_invoice optional boolean
show_download_receipt optional boolean
show_invoice_info optional boolean
show_thank_label optional boolean
uuid optional string 
             <payment_form_v2model>
  <url>string</url>
</payment_form_v2model>
{ } PaymentFormV2Model
url required string