Encoded URL POST

String: WEBHOOK TRANSACTION URL FOR PAYMENT STAGE (URL on which we will send payment gateway response to the third party)

String: WEBHOOK URL FOR PAYMENT STAGE (Specify the call back URL you want to receive webhook notifications to) (In the case of linktopay: this will be the linktopay_url you want the Link to pay response to be sent)

Decimal: A numeric value for the transaction gross charge stated to two decimal places

Number: The numeric ID number of the agent is up to 6 digits long, required with telephony payments. The length of this field is set by the Paytia platform so please check what your account is set to. By default, Paytia uses three-digit ID numbers for agents allowing 999 agent values to be utilised.

String: Paytia required value for Agent Name

String: use for accounting purposes. This is also posted onto the associated payment gateway where the payment gateway supports additional payment metadata fields.

String: Stripe and Braintree ONLY This field control allows you to post the cus_ value (Stripe), or the CustomerID or a new ID value (Braintree)., representing the customer record the transaction should be placed for.

String: First name of the card holder

String: Last name (surname) of the card holder

String: Allows a value to be passed for the customer's company name. This is displayed on the payment page the customer views to complete their payment.

String: Cardholder country code (in two alpha character ISO format)

String: Billing address line 1, used in AVS check.

Two letter country code defined in ISO 3166-1

String: Billing city.

String: Billing street.

String: Billing country/state

String: Billing postal code, used in AVS check

String: Billing description. A free text field to add extra information to the billing address.

String:Two-letter country code defined in ISO 3166-1

String: Recipient's first names.

String: Recipient's last name.

String: Billing address line 1, used in AVS check.

String: Shipping city.

String: Shipping country/state

String: Shipping Postal code/Zipcode

String: shipping description. free text field to add extra information to the billing address. This adds a description of goods/service purchased value to the customer payment form Max characters = 40

String: Three alpha character values (If null then the default currency will pick up from merchant account according to country set) Currenly currency is controlled only from Operating settings in the merchant portal https://demo.pay729.{domain_extension}/merchant/addon_license_country

String: ISO country code (2 alpha characters) (If null then the default language will be picked up from merchant country code set on the Paytia admin portal)

Integer: Enum - Stripe ONLY (0 - 1) This setting controls the storage of the payment card after the payment has been completed. You will use this with Stripe if you want to delete vs retain the card on file. If the passed value is = 0 then the payment card is retained after the transaction completes. If the value passed is = 1 then the payment card is removed after completing the transaction.

Stripe and Braintree Gateways only 0 = default (pay with existing payment card on customer account) 1 = capture new payment card (pm_ value (Stripe) or customer ID (Braintree)) to process the payment

Integer: Enum (0 - 1) This controls linktopay url for payment 0 = will send linktoapy url and webhook response to webhook url 1 = return linktopay_url in response 0 is active by default

Integer: Enum (0 - 1) Lock the fields on the agent form so they cannot be edited 0 = unlocked 1 = locked

Integer: Enum (0 - 3) This controls Paytia generating a payment link or a QR code. 0 = Payment link generated 1 = QR code generated (email_address is required in order for the generated QR code to be sent to a customer) 2 = QR code is returned in the webhook_url 0 is active by default

Numeric: Set the link expiry timer (integer value in seconds) 0 default value (link will not expire)

Numeric: This field control if instructing Paytia to send a link as an email to an email address you provide. 0 = disabled 1 = send using Paytia email service 2 = send using Paytia merchant customised email server settings 0 is the default value

String: Used to provide Paytia with the email address to send the link to the customer on If an email address is present and the send_email value is not set to 0 then Paytia will not return a web_payment_form URL

Integer: send_receipt requires a licence called "Receipt to the customer" to be active on your account. 0 = off (by default) 1 = on / send email receipt to the email_address value passed

Integer: Enum (0 - 1) This activates adding a custom logo to the transaction payment form customers see when paying. The custom logo is uploaded in the Paytia merchant portal, Settings menu. 0 = disabled 1 = use the custom logo setup on the Paytia merchant portal 0 will be the default value

String: This adds a description of goods/service purchased value to the customer payment form. Max characters = 100

Integer: Enum (0 - 9) 0 = Phone - None required = immediate charge 1 = Phone - Capture - Tokenisation only (ensure you send 0.00 in amount) 2 = Phone - Pre-auth (Capture to pre-auth (reserve) and take an immediate payment) 3 = Phone - Pre-auth only (set a reserve on a card and return a transaction token) 4 = Link to Pay 5 = Phone - Recurring payment 6 = Bank to bank payments (to be added) 7 = Phone - Rolling reserve (Stripe only) 8 = Checkout payment type (used for "Checkout" in thirdparty/payment_service and API/payment_service) 9 = Bank outbound payment processing

Integer: This value is used to switch the value passed in reference_number and reference_id so that 0 = show the reference_id field in the Paytia ACA user webform screen and send to reference_id to the PSP as the reference number field. 1 = show the reference_number value in the ACA screen and pass both reference_id and reference number to PSP.

String: A 'UNQUIQUE' ID value for the transaction. This is passed back with each webhook response so you can track the transaction flow.

String: Invoice Reference Number (this field is mapped and passed to the final payment gateway connector in ) for referencing the order. Note: on some payment gateways this is unique field meaning the payment gateway will reject repeat values that are not unique).

Date: Supported format is date (YYYY-MM-DD) example 2022-06-16 The date at which this phase of the subscription ends. If set, 'intervafrequency' must not be set.

String: Daily,weekly,monthly This provides three intervals for a subscription like: Subscription For - Daily | Weekly | Monthly

Integer: The number of intervals (specified in the interval attribute) between subscription billings. For Example: Interval=month and interval_count=3 bills every 3 months.

Integer: representing the multiplier applied to the price interval. For Example - intervalfrequency=2 applied to a price with interval-month and intervalcount=3 results in a phase of duration 2*3 months = 6 months. If set, end_date must not be set.

String: ISO country code (2 alpha characters) (If null then the default language will be picked up from merchant country code set on the Paytia admin portal)

String: This allows you to set the language by setting a language name i.e. french