Pay for an order using an existing PaymentToken
paymentToken required | string |
request3DS | boolean Request that a 3D secure challenge is attempted when payment is made. Defaults to |
returnURL | string If |
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 |
offSession | boolean Indicate that the card-owner is present or absent (off-session). For example, set this to |
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) |
Payment Success
Payment Action Required
{- "paymentToken": "ptkn_ZtqZDMfCgH3XrnJy",
- "request3DS": true,
- "returnURL": "string",
- "authoriseOnly": true,
- "offSession": true,
- "cardStatement": {
- "name": "string",
- "city": "string"
}, - "paymentActionRequired": {
- "threeDSAuthorisationId": "string",
- "redirectURL": "string"
}
}
{- "transactionId": "tran_ZtqZCsfCgH3XrnJc",
- "transactionStatus": "accepted",
- "amount": 0,
- "currency": "AUD",
- "surchargeAmount": 0,
- "type": "payplan"
}