API Reference

Create a Payment Link

post
https://api-dev.gettrx.com/payments/v1/payment-links
Body Params
string
required

Payment link name/title. Max Length: 250.

string

Payment link title. Max Length: 250.

string

Payment link description. Max Length: 500.

string
enum
required

String representing the price type.

Allowed:
number | null

Donation Amount Goal for payment link. Allowed only for payment link of type donation. Required when showGoal property is set to true. Valid range from 1.00 to 99,999,999.99.

boolean | null

Determines whether or not to show the donation goal for the payment link. Allowed only for payment link of type donation.

integer

Maximum number of completed Sessions until the payment link is invalidated. Range: 0 - 999. Can be null which means unlimited.

string | null

Message to be returned to the customer when the payment link is inactive. Max Length: 250.

lineItems
array of objects
required
lineItems*
boolean
Defaults to true

Whether or not the payment link is active.

afterCompletion
object

Determines checkout flow behavior after completion of the payment.

string
Defaults to usd

3 letter iso currency code. Currently it only accepts 'usd'.

customFields
array of objects

Max 5 items.

customFields
string
enum
Defaults to automatic

Use 'automatic' for full sale and 'manual' for 'Auth Only'.

Allowed:
string
enum
Defaults to if_required

Determines if a customer will be created during payment process. if_required: Only creates a customer when the price is for a “subscription”, and when savePaymentMethodForFutureUsage is set to “always”. always: Always create a customer regardless of the price type.

Allowed:
string
enum

Determines if the payment method saved will be created during payment process. if_required: Will not store the payment method when the price amount is 0. Will not store the payment method for any transactions ran through the payment page unless its for a subscription. always: Always store the payment method used by the customer for future payments.

Allowed:
paymentMethodTypes
array of strings

Determines which payment methods will be displayed in the payment link. The valid options are: us_bank_account: Enables payments with US bank accounts. card: Enables payments with card, apple pay, google pay.

paymentMethodTypes
boolean
Defaults to false

Determines if we need to collect the customer’s billing address (other than the zipcode).

boolean
Defaults to false

Determines if we need to collect the customer’s phone number.

boolean
Defaults to false

Determines if we need to collect the customer’s shipping address.

shippingCountriesAllowed
array of strings

Array with a list of countries to which the product can be shipped. Countries in array must be represented by their 2-letter iso code. Array should be restricted to no more than 200 options. When null, all countries are allowed. Currently only allows 'us'.

shippingCountriesAllowed
shippingRatesAvailable
array of strings | null

Reserved for future use.

shippingRatesAvailable
accountFees
object
accountDiscounts
object
string
enum
Defaults to surcharge

Describes the layout to be used when displaying the fees and discounts.

Allowed:
string | null
enum

When using donation layout, donor is able to see a checkbox to pay for the donation fees. This field determines the default state of that button. Only allowed when link type is donation and 'accountFees' property has at least 1 item.

Allowed:
string
Defaults to Pay {amount} now

A text string with what will be displayed in the Payment Button on the hosted payment page. It can have an {amount} token which would then be replaced by the final amount to be paid by the user. eg: “Pay {amount} now”.

boolean
Defaults to true

Determines whether or not to display the business contact information.

customBranding
object

Constains branding details.

subscriptionData
object | null

Reserved for future use.

boolean
Defaults to true

Determines whether or not to send a receipt at the end of the transactions.

string

Site Id for the customer that will be created during a checkout session either for a subscription or when createCustomer = always. Must be a valid and active site id that has not been deleted. This site should be propagated to checkout session generated from the payment link. This will allow for both the customer/subscription/invoice to also contain the site id.

Headers
string

Secret key associated to the partner’s account

string

Unique key generated by the partner

string

AccountId of the merchant that will own the product

Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago