pay-order-request.md

Pay Order Request

Defines the fields that are included in requests to the PayOrder endpoint.

Structure

PayOrderRequest

Fields

Name	Type	Tags	Description	Getter	Setter
idempotencyKey	string	Required	A value you specify that uniquely identifies this request among requests you have sent. If you are unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. For more information, see Idempotency. Constraints: Minimum Length: 1, Maximum Length: 192	getIdempotencyKey(): string	setIdempotencyKey(string idempotencyKey): void
orderVersion	?int	Optional	The version of the order being paid. If not supplied, the latest version will be paid.	getOrderVersion(): ?int	setOrderVersion(?int orderVersion): void
paymentIds	?(string[])	Optional	The IDs of the payments to collect. The payment total must match the order total.	getPaymentIds(): ?array	setPaymentIds(?array paymentIds): void

Example (as JSON)

{
  "idempotency_key": "c043a359-7ad9-4136-82a9-c3f1d66dcbff",
  "payment_ids": [
    "EnZdNAlWCmfh6Mt5FMNST1o7taB",
    "0LRiVlbXVwe8ozu4KbZxd12mvaB"
  ],
  "order_version": 102
}