Skip to content

Commit 960ee6b

Browse files
alexphelpsalexphelps
committed
refactor and restructure apm payment flow guides
1 parent ba3f1af commit 960ee6b

8 files changed

Lines changed: 342 additions & 82 deletions

File tree

‎docs/api/admin/guides/3ds2.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
sidebar_label: 3DS2
3-
sidebar_position: 4
2+
sidebar_label: 3DS Payments
3+
sidebar_position: 3
44
tags:
55
- Guide
66
---

‎docs/api/admin/guides/bancontact.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
sidebar_label: Bancontact
3+
sidebar_position: 5
4+
tags:
5+
- Guide
6+
---
7+
8+
# Bancontact Admin API Guide
9+
10+
**Bancontact** is a fully integrated payment method that is supported both in the storefront checkout, and via the Admin API.
11+
12+
13+
Bancontact transactions send the customer through a Bancontact redirect flow, with the resulting order information provided back to your application. Below are the steps needed to get Bancontact set up and working on the Admin API.
14+
15+
16+
### API Payment Redirect Flow
17+
18+
```mdx-code-block
19+
20+
import RedirectPaymentFlow from '@site/_snippets/_redirect-payment-flow.mdx';
21+
22+
<RedirectPaymentFlow />
23+
```
24+
25+
### Create Order on Admin API
26+
27+
When creating a new order using Bancontact using the orders_create API method, you must specify the `payment_method=bancontact` as well as provide a `payment_return_url`. The `payment_return_url` is your endpoint that will receive a POST request containing the final order data.
28+
29+
30+
```json title="Payment Details for Order with Bancontact"
31+
{
32+
"payment_method": "bancontact",
33+
"payment_details": {
34+
"payment_return_url": "<external checkout url>",
35+
"payment_gateway": "<gateway id>", // optional
36+
"payment_gateway_group": "<gateway group id>" // optional
37+
}
38+
}
39+
```
40+
41+
:::tip
42+
You can optionally provide a `payment_gateway` when creating the order to use a Bancontact account connected to a specific gateway.
43+
44+
:::
45+
46+
### Redirect Customer to Bancontact
47+
The response when creating the order will provide a `payment_complete_url`. Your application should redirect the customer to this URL for completing the payment on Bancontact.
48+
49+
```json title="Response with Payment Complete URL"
50+
{
51+
"reference_transaction_id": null,
52+
"payment_complete_url": "<unique checkout url>"
53+
}
54+
```
55+
56+
### Receiving Order Data
57+
```mdx-code-block
58+
59+
import RedirectPaymentStep3 from '@site/_snippets/_redirect-payment-flows-step-3.mdx';
60+
61+
<RedirectPaymentStep3 />
62+
63+
```
64+
65+
### Upsells
66+
67+
Upsells are not supported with Bancontact payments.

‎docs/api/admin/guides/ideal.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
sidebar_label: iDEAL
3+
sidebar_position: 5
4+
tags:
5+
- Guide
6+
---
7+
8+
# iDEAL Admin API Guide
9+
10+
**iDEAL** is a fully integrated payment method that is supported both in the storefront checkout, and via the Admin API.
11+
12+
iDEAL transactions send the customer through a iDEAL redirect flow, with the resulting order information provided back to your application. Below are the steps needed to get iDEAL set up and working on the Admin API.
13+
14+
15+
### API Payment Redirect Flow
16+
17+
```mdx-code-block
18+
19+
import RedirectPaymentFlow from '@site/_snippets/_redirect-payment-flow.mdx';
20+
21+
<RedirectPaymentFlow />
22+
```
23+
24+
### Create Order on Admin API
25+
26+
When creating a new order using iDEAL using the orders_create API method, you must specify the `payment_method=ideal` as well as provide a `payment_return_url`. The `payment_return_url` is your endpoint that will receive a POST request containing the final order data.
27+
28+
29+
```json title="Payment Details for Order with iDEAL"
30+
{
31+
"payment_method": "ideal",
32+
"payment_details": {
33+
"payment_return_url": "<external checkout url>",
34+
"payment_gateway": "<gateway ID with iDEAL account>" // optional
35+
}
36+
}
37+
```
38+
39+
:::tip
40+
You can optionally provide a `payment_gateway` when creating the order to use a iDEAL account connected to a specific gateway.
41+
42+
:::
43+
44+
### Redirect Customer to iDEAL
45+
The response when creating the order will provide a `payment_complete_url`. Your application should redirect the customer to this URL for completing the payment on iDEAL.
46+
47+
```json title="Response with Payment Complete URL"
48+
{
49+
"reference_transaction_id": null,
50+
"payment_complete_url": "<unique checkout url>"
51+
}
52+
```
53+
54+
### Receiving Order Data
55+
```mdx-code-block
56+
57+
import RedirectPaymentStep3 from '@site/_snippets/_redirect-payment-flows-step-3.mdx';
58+
59+
<RedirectPaymentStep3 />
60+
61+
```
62+
63+
### Upsells
64+
65+
Upsells are not supported with iDEAL payments.

‎docs/api/admin/guides/iframe-payment-form.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: iFrame Payment Form
3-
sidebar_label: iFrame Payment Form
2+
title: Bankcard iFrame Payment Form
3+
sidebar_label: Bankcard iFrame
44
sidebar_position: 2
55
tags:
66
- Guide

‎docs/api/admin/guides/klarna.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
sidebar_label: Klarna
3+
sidebar_position: 4
4+
tags:
5+
- Guide
6+
---
7+
8+
# Klarna Admin API Guide
9+
10+
**Klarna** is a fully integrated payment method via NEXT Payments and Stripe, supported both in the storefront checkout and via the Admin API.
11+
12+
Klarna transactions send the customer through a Klarna redirect flow, with the resulting order information provided back to your application. Below are the steps needed to get Klarna set up and working on the Admin API.
13+
14+
### API Payment Redirect Flow
15+
16+
```mdx-code-block
17+
18+
import RedirectPaymentFlow from '@site/_snippets/_redirect-payment-flow.mdx';
19+
20+
<RedirectPaymentFlow />
21+
```
22+
23+
### Create Order on Admin API
24+
25+
When creating a new order using Klarna using the orders_create API method, you must specify the `payment_method=klarna` as well as provide a `payment_return_url`. The `payment_return_url` is your endpoint that will receive a POST request containing the final order data.
26+
27+
28+
```json title="Payment Details for Order with Klarna"
29+
{
30+
"payment_method": "klarna",
31+
"payment_details": {
32+
"payment_return_url": "<external checkout url>",
33+
"payment_gateway": "<gateway id>", // optional
34+
"payment_gateway_group": "<gateway group id>" // optional
35+
}
36+
}
37+
```
38+
39+
:::tip
40+
You can optionally provide a `payment_gateway` when creating the order to use a Klarna account connected to a specific gateway.
41+
42+
:::
43+
44+
### Redirect Customer to Klarna
45+
The response when creating the order will provide a `payment_complete_url`. Your application should redirect the customer to this URL for completing the payment on Klarna.
46+
47+
```json title="Response with Payment Complete URL"
48+
{
49+
"reference_transaction_id": null,
50+
"payment_complete_url": "<unique checkout url>"
51+
}
52+
```
53+
54+
### Receiving Order Data
55+
```mdx-code-block
56+
57+
import RedirectPaymentStep3 from '@site/_snippets/_redirect-payment-flows-step-3.mdx';
58+
59+
<RedirectPaymentStep3 />
60+
61+
```
62+
63+
### Upsells
64+
65+
Klarna supports one-click upsells through the [ordersAddLineItemsCreate](/docs/api/admin/reference/#/operations/ordersAddLineItemsCreate) API, enabling additional items to be added to the order with a payment transaction.
66+
67+
### Recurring
68+
69+
Klarna via NEXT Payments supports recurring transactions and can be used as a payment method for an order with subscription items.

‎docs/api/admin/guides/sepa-debit.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
sidebar_label: SEPA Direct Debit
3+
sidebar_position: 5
4+
tags:
5+
- Guide
6+
---
7+
8+
# SEPA Direct Debit Admin API Guide
9+
10+
**SEPA Direct Debit** is a fully integrated payment method that is supported both in the storefront checkout, and via the Admin API.
11+
12+
SEPA Direct Debit transactions send the customer through a SEPA Direct Debit redirect flow, with the resulting order information provided back to your application. Below are the steps needed to get SEPA Direct Debit set up and working on the Admin API.
13+
14+
15+
### API Payment Redirect Flow
16+
17+
```mdx-code-block
18+
19+
import RedirectPaymentFlow from '@site/_snippets/_redirect-payment-flow.mdx';
20+
21+
<RedirectPaymentFlow />
22+
```
23+
24+
### Create Order on Admin API
25+
26+
When creating a new order using SEPA Direct Debit using the orders_create API method, you must specify the `payment_method=sepa_debit` as well as provide a `payment_return_url`. The `payment_return_url` is your endpoint that will receive a POST request containing the final order data.
27+
28+
29+
```json title="Payment Details for Order with SEPA Direct Debit"
30+
{
31+
"payment_method": "sepa_debit",
32+
"payment_details": {
33+
"payment_return_url": "<external checkout url>",
34+
"payment_gateway": "<gateway id>", // optional
35+
"payment_gateway_group": "<gateway group id>" // optional
36+
}
37+
}
38+
```
39+
40+
:::tip
41+
You can optionally provide a `payment_gateway` when creating the order to use a SEPA Direct Debit account connected to a specific gateway.
42+
43+
:::
44+
45+
### Redirect Customer to SEPA Direct Debit
46+
The response when creating the order will provide a `payment_complete_url`. Your application should redirect the customer to this URL for completing the payment on SEPA Direct Debit.
47+
48+
```json title="Response with Payment Complete URL"
49+
{
50+
"reference_transaction_id": null,
51+
"payment_complete_url": "<unique checkout url>"
52+
}
53+
```
54+
55+
### Receiving Order Data
56+
```mdx-code-block
57+
58+
import RedirectPaymentStep3 from '@site/_snippets/_redirect-payment-flows-step-3.mdx';
59+
60+
<RedirectPaymentStep3 />
61+
62+
```
63+
64+
### Upsells
65+
66+
Upsells are not supported with SEPA Direct Debit payments.

‎docs/api/admin/guides/stripe-apms.md‎

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)