Simple Payment Scenarios

One-Step Payment

Description

For One-Step Payments, the sum paid for the purchase is written off the customer's account immediately.

One-Step Payment is compatible with the following payment scenarios and additional capabilities:

  • Full Refund
  • Partial Refund
  • Reversal
  • Recurring
  • Recurring (Automatic)
  • One-Click
  • Payment Method Saving
  • Use of Travel Data
  • Use of Account Funding details
  • Use of Dynamic Descriptor
  • Use of Service Location details
  • QCash
  • MOTO
  • SDWO Funding Payment
  • SDWO Purchase Payment
  • Taxes
  • AVS

Request Example

Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com"
    },
    "products": [
        {
            "price": 0.01,
            "title": "Test product"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Two-Step Payment

Description

For Two-Step Payment transactions, money is not immediately written off the customer's account: it is reserved on the card and captured later. Capture can be made only once; namely, if it is not made in full, the rest of the amount will be returned.

The cancellation process of HOLD (i.e. the reservation of funds) differs, depending on the processing. The funds can be reserved from 6 up to 28 days. If you want to find out more about your particular processing, contact your Cardaq account manager.

Two-Step Payment is compatible with the following payment scenarios and additional capabilities:

  • Full Refund
  • Partial Refund
  • Reversal
  • Recurring
  • Recurring (Automatic)
  • One-Click
  • Payment Method Saving
  • Use of Travel Data
  • Use of Dynamic Descriptor
  • Use of Service Location details
  • QCash
  • MOTO
  • SDWO Funding Payment
  • SDWO Purchase Payment
  • Taxes
  • AVS

Request Example

  1. Create a new request to POST /orders/. Note that the price value must be ≥0.01.
{
    "client": {
        "email": "test@test.com"
    },
    "skip_capture": true,
    "products": [
        {
            "price": 10.00,
            "title": "Test product"
        }
    ]
}
  1. Create a new request to POST /orders/{order_id}/capture/. Note that the price value must be ≥0.01 and ≤ the initial amount provided in the first step.
{
    "total": 10.00
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Zero-Amount Payment

Description

Zero-Amount Payment transactions allow merchants to save the payment method and reserve funds for the subsequent payments in the future. Namely, Zero-Amount Payment scenario allows registering a recurring without executing a financial transaction. Alternatively, this scenario can be used for the payment/card account verification.

Zero-Amount Payment is compatible with the following capabilities:

  • Payment Method Saving
  • Use of Travel Data
  • Use of Dynamic Descriptor
  • Use of Service Location details
  • MOTO
  • AVS

Request Example

Create a new request to POST /orders/. Note that either of these two parameters - setup_future_use or force_save_method must be included.

{
    "client": {
        "email": "test@test.com",
        "original_client": "xxx…xxx"
    },
    "payment_system": "AUTH",
    "force_save_method": true
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Note that original_client is NOT a mandatory field if you just want to save a card, using zero amount authentication on the merchant's side.

Full Refund

Description

Full Refund allows you to return cash funds in full amount to the customer’s card account.

Full Refund is compatible with the following payment scenarios and additional capabilities:

  • One-Step Payment
  • Two-Step Payment
  • Recurring
  • Recurring (Automatic)
  • One-Click
  • Payment Method Saving
  • Use of Travel Data
  • Use of Account Funding details
  • Use of Dynamic Descriptor
  • Use of Service Location details
  • QCash
  • MOTO
  • SDWO Funding Payment
  • SDWO Purchase Payment
  • Taxes

Note that refunds can be made only for payments that are not older than two years.

For payments processed through certain card acquirers, a refund request may be declined if the chargeback has already been received for the particular payment. Decline message example: Refund initiation is declined because of RDR value.

Request Example

Create a new request to POST /orders/{order_id}/refund/ without a request body.

Partial Refund

Description

Partial Refund allows you to return cash funds in a partial amount to the customer’s card account.

Partial Refund is compatible with the following payment scenarios and additional capabilities:

  • One-Step Payment
  • Two-Step Payment
  • Recurring
  • Recurring (Automatic)
  • One-Click
  • Payment Method Saving
  • Use of Travel Data
  • Use of Account Funding details
  • Use of Dynamic Descriptor
  • Use of Service Location details
  • QCash
  • MOTO
  • SDWO Funding Payment
  • SDWO Purchase Payment
  • Taxes

Note that refunds can be made only for payments that are not older than two years.

For payments processed through certain card acquirers, a refund request may be declined if the chargeback has already been received for the particular payment. Decline message example: Refund initiation is declined because of RDR value.

Request Example

Create a new request to POST /orders/{order_id}/refund/. Note that the amount value must be ≥0.01.

{
    "amount": 0.01
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Reversal

Description

Reversal transactions can be only carried out on the same day the customer has paid the order. Reversal allows you to return money only in full.

Reversal is compatible with the following payment scenarios and additional capabilities:

  • One-Step Payment
  • Two-Step Payment
  • Recurring
  • Recurring (Automatic)
  • One-Click
  • Payment Method Saving
  • Use of Travel Data
  • Use of Account Funding details
  • Use of Dynamic Descriptor
  • Use of Service Location details
  • QCash
  • MOTO
  • SDWO Funding Payment
  • SDWO Purchase Payment
  • Taxes

Request Example

Create a new request to POST /orders/{order_id}/reverse/ without a request body.