Create Payment Link

post

https://api.paygreen.fr/payment/payment-links

Allows you to create a payment links for a given payment order template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

integer

required

The amount (in cts)

auto_capture

boolean

required

Defaults to true

If true, the operations will be automatically captured whenever possible. Otherwise, you need to call the Capture endpoint. Default is true.

buyer

required

Existing Buyer ID, or new Buyer entity. Required if Instrument is not set.

currency

string

enum

required

Allowed:

description

string

An optional description to this Payment Link

expires_at

string

required

You need to setup an expires date to this payment link.

platforms

array of strings

An array containing the platforms that can be processed through this Payment Link. If not set, all the validated Platforms of your Shop will be available.

platforms

Allowed:

reference

string

required

Your reference to this Payment Link

shop_id

string

sh_[0-9a-f]{32}

The beneficiary Shop ID. If you are a Marketplace, set the sub-entity ID here.

plbs

boolean

required

Defaults to false

Only for bank_card platforms. Set to true to extend the authorisation period to 30 days, if your business is in an eligible category (eg. hotel, rental...).

Responses

400

Bad request

401

Unauthenticated

403

Forbidden

422

Unprocessable request

Language

Credentials

URL

Loading…

Response

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

application/json

200Payment Link successfully created