Create

The Payment Order creation is the entry point for any payment you need to process.

If you need to process Authorization in the same time, you can set the authorize parameter. This parameter is an object that must contain the parameters you would set on the Authorize call.

Parameters

Name	Description
`amount`	The amount, in cents	`required`
`authorize`	Authorization parameters. Set this object if you need to process Authorization right after the Payment Order creation. Only available for platforms without strong authentication.
`auto_capture`	If `true`, the operations will be automatically captured whenever possible. Otherwise, you'll need to call the Capture endpoint. Default is `true`
`buyer`	The Buyer object, or id (`buy_`) of an existing Buyer	`required`
`capture_on`	Set this parameter if you need us to capture the operations on a specific day and hour. Format : yyyy-mm-dd, example : 2022-05-21
`currency`	Currency	`required`
`description`	An optional description to this Payment Order
`max_operations`	The maximum number of operations. If the amount is not reached with this number of operations, the Payment Order will automatically be canceled (and the potential authorizations made). Default is `null` (no maximum)
`mode`	Recurrence of the Payment Order. Only `instant` mode is available at the moment	`required`
`partial_allowed`	If `true`, the Payment Order will be successful immediatly after an operation is Authorized, regardless of the amount. Default is `false`
`platforms`	An array containing the platforms that can be processed through this Payment Order. If not set, all the validated Platforms of your Shop will be available. If one of these platforms is not available during the payment process, it will be removed and will not be used.
`reference`	Your reference to this Payment Order
`shipping_address`	The Shipping Address associated with this order
`ttl`	Time To Live, in seconds. Default : 600. Max : 3600.
`return_url`	The URL of redirection after a payment is processed on our hosted page
`cancel_url`	The URL of redirection after a payment is canceled on our hosted page

Marketplace Parameters

Name	Description
`fees`	Your fees amount (in cts). `platforms` and `shop_id` are required. Only for bank_card platforms with wallet enabled.
`shop_id`	The Shop ID for which you are processing this Payment Order

Tutorial

💳 Create instant payment Learn how to create instant payments with PayGreen. View Tutorial →