API Reference

Create a payment link

post
https://sandbox.pingpayments.com/payment_links/api/v1/payment_links
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The user attributes

string | null

Customer gets redirected here when canceling a checkout

string | null

Customer gets redirected here when completed a checkout successfully

string | null

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

string
enum
required

The currency which the amount is given in

Allowed:
customer
object
required

Request body for a customer

delivery_address
object | null
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*
string
enum
required

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

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

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.

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
integer
required
≥ 0

The total amount in the smallest denomination

boolean
Defaults to false
Headers
Responses

Callback

Updated 5 months ago

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

Updated 5 months ago