Create a payment link

post

https://sandbox.pingpayments.com/payment_links/api/v1/payment_links

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The user attributes

Request body for creating a new PaymentLink

checkout_cancel_url

string | null

Customer gets redirected here when canceling a checkout

checkout_success_url

string | null

Customer gets redirected here when completed a checkout successfully

checkout_url

string | null

The url to the checkout (should only be set if building a custom checkout)

currency

string

enum

required

The currency which the amount is given in

Allowed:

customer

object

required

Request body for a customer

delivery_address

object | null

due_date

date

The expiration date of the PaymentLink

invoice_address

object | null

items

array of objects

required

The items which will be sold in the PaymentLink

items*

locale

string

enum

required

The language used for the invoice. This will determine the language on the receipt/invoice and the checkout

logo_image_link

string | null

An url to a png image to view on the invoice and receipt. The image dimensions should be approximately 3:1 for the best fit.

metadata

object | null

Set of key-value pairs for storing additional information about the PaymentLink

payment_link_status_callback_url

string | null

The callback which gets triggered when a payment link status is changed. To prevent retries you should respond 204 to this callback.
The body of the callback contains a jsonstring with the fields status & payment_link_id
The status in the callback body is either EXPIRED or COMPLETED
You won't get a callback when the status is set to CREATED or CANCELLED, this is because the only way for a PaymentLink to enter any of these states is by a synchronously http call by you.

payment_order_id

uuid

required

Payment Order Id

payment_provider_methods

array of objects

required

The payment provider methods available in the checkout.

payment_provider_methods*

supplier

object

required

total_amount

integer

required

≥ 0

The total amount in the smallest denomination

ui_less

boolean

Defaults to false

Headers

tenant_id

uuid

required

TenantId

Responses

Callback

Language

Loading…

Response

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

application/json

200payment_links_respons

403ApiErrorResponse

422validationerror