Pay Order

Pay for an order using an existing PaymentToken

SecurityLimepay-SecretKey

Request

path Parameters

merchantOrderId

required

string

Request Body schema: application/json

paymentToken required	string
request3DS	boolean Request that a 3D secure challenge is attempted when payment is made. Defaults to `false`
returnURL	string If `request3DS` is specified, a URL to return to must also be given when the 3DS challenge is completed. Defaults to https://checkout.limepay.com.au/payment-action-return.html
authoriseOnly	boolean Authorise payment only. This means funds on the payment method are not captured and are only held for a maximum of 7 days. See https://docs.limepay.com.au/ on how to capture funds. Defaults to `false`.
offSession	boolean Indicate that the card-owner is present or absent (off-session). For example, set this to `true` if you're charging a customers saved payment method and they are not present. Defaults to `false`.
	object (PaymentDescription) If set, these details will be used for card payments to set the descriptor shown on the cardholders statement. If unset, the merchant's business details obtained at onboarding will be used by default.
	ThreeDSAuthorisation (object) (PaymentActionRequired) An action that must be completed before the payment can be completed. See https://docs.limepay.com.au/ for more info.

Responses

200

Payment Success

400

401

403

Payment Action Required

404

405

409

422

429

500

501

503

post/orders/{merchantOrderId}/pay

Request samples

Payload
Curl
JavaScript

application/json

{"paymentToken": "ptkn_ZqCNZRMSwU7yXmCz",
"request3DS": true,
"returnURL": "string",
"authoriseOnly": true,
"offSession": true,
"cardStatement": {"name": "string",
"city": "string"
},
"paymentActionRequired": {"threeDSAuthorisationId": "string",
"redirectURL": "string"
}
}

Response samples

application/json

{"transactionId": "tran_ZqCNYhMSwU7yXmCc",
"transactionStatus": "accepted",
"amount": 0,
"currency": "AUD",
"surchargeAmount": 0,
"type": "payplan"
}