Overview
Methods
| Task | Method |
|---|---|
| Accept a payment with card data on your side | Pay by card; if 3DS is required, then Pay by card: complete 3DS |
| Charge a card saved in a recurring profile | Pay by recurring profile |
| Redirect the client to the Freedom Pay payment page | Create payment page, or Create payment page with any amount if the client enters the amount |
| Capture a two-step payment | Capture payment (clearing) |
| Release a two-step payment before the capture | Cancel payment |
| Return money for a captured payment | Refund payment |
| Get the result and the details of a payment | Get payment status |
One-step and two-step payments
pg_auto_clearing = 1): the amount is captured at authorization. To return the money, call Refund payment.pg_auto_clearing = 0): the amount is only blocked at authorization. Then capture it with Capture payment (clearing) or release it with Cancel payment. After the capture, the money is returned with Refund payment.pg_auto_clearing is not passed, the scheme from the merchant settings is used.Payment statuses
pg_payment_status in Get payment status.authorized, declined — the result of Pay by card or Pay by recurring profile.
3DS — the client must pass 3DS authentication, then Pay by card: complete 3DS is called.
payment page — the payment is created by Create payment page and waits for the client.
A two-step payment keeps
success after authorization with pg_captured = 0; the capture sets pg_captured = 1.A cancel or a refund does not change the status: see
pg_captured, pg_refund_amount and the lists of operations.