Create a Payment Link

post

https://api-dev.gettrx.com/payments/v1/payment-links

Body Params

name

string

required

Payment link name/title. Length 256

title

string

Payment link title. Length 500

type

string

enum

String representing the price type. The available options are: single_amount, checkout, and donation.

Allowed:

goal

float

Donation Amount Goal for payment link.

showGoal

boolean

Determines whether or not to show the donation goal for the payment link.

displayDonationLabels

boolean

Determines whether or not to display the donation labels.

maxCompletedSessions

integer

Maximum number of completed Sessions until the payment link is invalidated.

inactiveMessage

string

Message to be returned to the customer when the payment link is inactive.

lineItems

array of strings

lineItems

active

boolean

Whether or not the payment link is active. Defaults to true when created.

afterCompletion

object

currency

string

enum

3 letter iso currency code.

Allowed:

customFields

object

Array with CustomField objects. Limit to array to having 5 custom fields max.

captureMethod

string

enum

Capture Method:

automatic : Use for full sale

manual: Use for “Auth Only”

Allowed:

createCustomer

string

enum

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:

savePaymentMethodForFutureUsage

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

string

enum

Determines which payment methods will be displayed in the payment link:

us_bank_account : Enables payments with US bank accounts

card : Enables payments with CARD, APPLE PAY, GOOGLE PAY

Allowed:

collectBillingAddress

boolean

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

collectPhoneNumber

boolean

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

collectShippingAddress

boolean

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.

shippingCountriesAllowed

shippingRatesAvailable

array of strings

An array of shipping rate ids to be displayed to the user as options during the checkout flow.

shippingRatesAvailable

accountFeeAndDiscountDisplayLayout

string

enum

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

Allowed:

donationFeeDefaultPayor

string

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

Allowed:

submitButtonText

string

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

showBusinessContactInformation

boolean

Determines whether or not to display the business contact information.

customBranding

object

Object with Branding details.

sendEmailReceipt

boolean

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

Headers

idempotencyKey

string

A unique identifier to ensure the same operation isn't processed multiple times, preventing duplicate transactions.

onBehalfOf

string

Specifies the account for which the Payment-Link is intended. This is used for scenarios where one partner creating payment-link on behalf of another partner, such as in PayFac or related partner relationships.

Responses

201201

401401