Create Payment Link

post

https://api.getpinch.com.au/test/payment-links

Body Params

amount

int64

required

The amount to be paid through the Payment link

payerId

string

required

Id of a Payer to create a Payment link for.

description

string

required

The description of the payment, shown on the payment page.

currency

string

Currency to take payment in (Will default to Merchant currency if not specified)

linkExpiryDate

date

DateTime for the Payment Link to expire

allowedPaymentMethods

array of strings

required

List of Payment Methods that can be used to take Payment. (Options are credit-card and bank-account)

allowedPaymentMethods*

surchargePaymentMethods

array of strings

Payment methods that a surcharge should be applied to when used. (Options are credit-card and bank-account)

surchargePaymentMethods

returnUrl

string

required

Url to redirect the user to once the payment has been completed. Parameters for paymentLinkId and paymentId will be added to redirected url.

metadata

string

Metadata is a free text field that you can use to store state against the Payment Link object, once Payment is complete the metadata will be passed onto the Payment object.

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400