When to use this
Email merge, no-code tools, or any system that can only emit a hyperlink. Construct the URL, drop it in a template, the customer clicks to pay.
Endpoint
GET https://accounts.paytia.com/api/payment_service
Try it
The URL POST API takes parameters as query string, not form-data. The explorer below builds the full URL for you as you edit.
Sandbox or live key — nothing is stored.
Decimal: A numeric value for the transaction gross charge stated to two decimal places
String: A 'UNQUIQUE' ID value for the transaction. This is passed back with each webhook response so you can track the transaction flow.
String: First name of the card holder
String: Last name (surname) of the card holder
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
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)
String: PhoneNumber - allows the passing of the customers preffered telephone number excluding the country code or the leading Zero digit. This will be shown with the country code you sent in. Note: used with transaction_flag=8
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: Description of the payment or service being purchased
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: Billing address line 1, used in AVS check.
String: Billing city.
String: Billing postal code, used in AVS check
Two letter country code defined in ISO 3166-1
String: Billing country/state
String: Billing street.
String: Cardholder country code (in two alpha character ISO format)
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 (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
Stripe ONLY: This works when transaction_flag is set to 4 Action - 0 = not used 1 = Reserve payment link 2 = Capture card (TOKEN) 3 = Recurring payment schedule 4 = Capture (TOKEN) then charge an immediate amount
Numeric: Set the link expiry timer (integer value in seconds) 0 default value (link will not expire)
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
curl 'https://accounts.paytia.com/api/payment_service?X-API-KEY=YOUR_API_KEY&amount=10.00&reference_id=REF-12345&firstname=Firstname&lastname=Lastname&email_address=customer%40example.com&webhook_url=%7BADD+YOUR+WEBHOOK+URL+HERE%7D&phone_number=7123456789¤cy_code=GBP&description=Payment+for+services&company_name=Acme+Corporation&billinghouseno=123&billingcity=London&billingpostcode=SW1A+1AA&billingcountry=GB&billingstate=England&billingstreet=Downing+Street&countrycode=GB&languagecode=en&transaction_flag=4&payment_link_type=qr&link_expiry=24&agent_id=100&agent_name=Agent+Name'
No response yet. Paste your key, tweak the values, and click Execute.
Fields
| Field | Type | Description |
|---|---|---|
| amount | text | Decimal: A numeric value for the transaction gross charge stated to two decimal places |
| reference_id | text | String: A 'UNQUIQUE' ID value for the transaction. This is passed back with each webhook response so you can track the transaction flow. |
| firstname | text | String: First name of the card holder |
| lastname | text | String: Last name (surname) of the card holder |
| email_address | text | 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 |
| webhook_url | text | 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) |
| phone_number | text | String: PhoneNumber - allows the passing of the customers preffered telephone number excluding the country code or the leading Zero digit. This will be shown with the country code you sent in. Note: used with transaction_flag=8 |
| currency_code | text | 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 |
| description | text | String: Description of the payment or service being purchased |
| company_name | text | 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. |
| billinghouseno | text | String: Billing address line 1, used in AVS check. |
| billingcity | text | String: Billing city. |
| billingpostcode | text | String: Billing postal code, used in AVS check |
| billingcountry | text | Two letter country code defined in ISO 3166-1 |
| billingstate | text | String: Billing country/state |
| billingstreet | text | String: Billing street. |
| countrycode | text | String: Cardholder country code (in two alpha character ISO format) |
| languagecode | text | 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) |
| transaction_flag | select | 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 |
| payment_link_type | select | Stripe ONLY: This works when transaction_flag is set to 4 Action - 0 = not used 1 = Reserve payment link 2 = Capture card (TOKEN) 3 = Recurring payment schedule 4 = Capture (TOKEN) then charge an immediate amount |
| link_expiry | text | Numeric: Set the link expiry timer (integer value in seconds) 0 default value (link will not expire) |
| agent_id | text | 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. |
| agent_name | text | String: Paytia required value for Agent Name |