Flows by payment type

Understand the flows by payment type.

Each payment method must follow a specific payment flow to ensure a seamless payment process. The payment flows and corresponding payment methods outlined below follow Digital River's recommended best practices.

Standard payment flow

Use the following flow for standard payments: Apple Pay, credit cards, and Google Pay.

1. Create the shopper token.

2. Apply the shopper and their billing address to a cart.

3. Create a source using DigitalRiver.js. The source state is chargeable.

4. Attach the source to the cart.

5. Submit the cart.

Delayed payment flow

Submit a Konbini payment flow

Use the following flow for delayed payments, such as Konbini.

1. Get the store details.

2. Create a source using DigitalRiver.js. The source state is pending_funds.

3. The customer transfers the funds to the Konbini payment provider.

4. The source state changes to chargeable when the funds are received.

5. Submit the cart.

Submit a Boleto payment flow

To use Boleto as a payment method:

1. Create a cart.

2. Optional. Set the locale and currency. curl --location --request GET 'https://{host}/v1/shoppers/me.json? locale=pt_BR&currency=BRL' --header 'Content-Type: application/json'--header 'authorization: bearer ***\

3. Optional. Set the cart address to the BR address.

4. Attach the tax ID to the cart. The action inserts the tax ID into the payment session.

5. Create a source using DigitalRiver.js with a payment session ID. Note that the tax ID is required when creating the Boleto source. The payment session ID provides the tax ID.

6. Attach the source to the cart.

7. Submit the cart.

Submit a Wire Transfer payment flow

Use the following flow for delayed payments, such as Wire Transfer.

1. Create the shopper token.

2. Apply the shopper and their billing address to a cart.

3. Create a source using DigitalRiver.js. The source state is chargeable.

4. Attach the source to the cart.

5. Submit the cart.

6. The shopper receives the payment details and completes the payment. After the shopper finalizes the payment, the updated order status will appear in Global Commerce.

Redirect, then submit payment flow

Use the following flow for redirect and submit payment methods, such as PayPal, PayPal Billing Agreement, PayPal Credit, PayPal Pay in 3, PayPal Pay in 4, and PayPal RatenZahlung (Installment Payment)

1. Create the shopper token.

2. Apply the shopper and their billing address to a cart.

3. Create a source using DigitalRiver.js. The source state is pending_redirect.

4. Complete the redirect authorization.

5. Attach the source to the cart. The session state is requires_confirmation.

6. Submit the cart.

Submit, then redirect payment flow

Use the submit, then redirect flow for Afterpay, Alipay (domestic), Alipay+ (cross-border), Amazon Pay Express Checkout, Bancontact, BLIK, CCAvenue, Clearpay, iDEAL, Klarna Financing, Klarna Pay in 3, Klarna Pay in 4, Klarna Pay in 30 days, Online Banking (IBP), Online Banking (FPX), Online Banking (Korea Bank Transfer), PayCo, SEPA Direct Debit, and TreviPay, and Trustly.

1. Create the shopper token.

2. Apply the shopper and their billing address to a cart.

3. Create a source using DigitalRiver.js with a session identifier (paymentSessionId). The source state is pending_redirect.

4. Attach the source to the cart. The session state is requires_confirmation.

5. Submit the cart. The session state is pending_redirect.

6. Complete redirect authorization. The session state is chargeable.

7. Resume cart to complete post-order processing.

Express checkout payment flow

Use the express checkout payment flow for Amazon Pay Express Checkout.

Submit an Amazon Pay flow

The following image shows Amazon Pay's Express Checkout flow for Commerce API.

The following Amazon Pay flow represents how your shoppers experience the payment process.

1. The shopper adds the product to the shopping cart

2. The shopper clicks the Shopping Cart

3. The shopper clicks the Amazon Pay button.

4. The shopper is redirected to Amazon Pay to sign in and select the shipping address (if required) and the payment method.

5. The shopper clicks the Submit button to place the order.

6. The shopper gets a second redirect to the Amazon Pay - Spinning page or Multi-factor Authentication (MFA) page. (Amazon Pay determines if the transaction requires MFA). The order will be in a source_pending_redirect state. You can get an order by its identifier to check the state of the order.

7. Optional. When you resume the cart, the order will be in an accepted state.

GET /orders/{189917880336}

curl --location --request GET 'https://api.digitalriver.com/orders/189917880336' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_key>' \
...

200 OK response

{
    "id": "189917880336",
    ...
    "state": "source_pending_redirect",
    ...
}

POST /v1/shoppers/me/carts/active/resume-cart

curl --location -g --request POST ' https://api.digitalriver.com/v1/shoppers/me/carts/active/resume-cart' \
--header 'Authorization: bearer {{access_token}}' \
...

200 OK response

{
    "id": "189917880336",
    ...
    "state": "accepted",
    ...
}