RPG Payments

The payment endpoint ('/api/payment') can be used to charge cards as well as working with transactions such as cancelling and capturing authorizations, refunding transactions and getting information on transactions.

Charging cards

To charge a card you need to perform a POST to the payment endpoint ('/api/payment'), you can use this to charge a card directly (Sale) or create an authorization on a card for future use (PreAuthorization).

3DSecure payments

The 3DSecure procedure is a procedure where the cardholder is authenticated resulting in less chance of fraudulent transactions. 3DSecure is mandatory for ecommerce transactions in Europe.

To enable 3DSecure payments you will need to connect to a Merchant Plugin Interface (MPI), SaltPay provides a MPI to its ECommerce customers but there are also other MPI vendors available. If you decide to use the MPI provided by SaltPay then RPG has a helper interface which can simplify the process. See 3DSecure - RPG Payments.

Request objects

PaymentRequest

PaymentMethod

Metadata

ThreeDSecure (3DSecure)

DynamicDescriptors

Note: Dynamic descriptors are enabled on per merchant basis, contact your service representative for more information.

Response objects

TransactionInfo

PaymentMethod

Metadata

Create Payment Examples

Example - Charging with card

curl <SERVICE_URL>/api/payment \
  -u <PRIVATE_ACCESS_TOKEN>: \
  -d "TransactionType=PreAuthorization" \
  -d "Amount=100" \
  -d "Currency=352" \
  -d "TransactionDate=2015-10-10T11:00:00" \
  -d "OrderId=TEST00000001" \
  -d "PaymentMethod.PaymentType=Card" \
  -d "PaymentMethod.PAN=4242424242424242" \
  -d "PaymentMethod.ExpYear=2020" \
  -d "PaymentMethod.ExpMonth=01"

PaymentRequest req = new PaymentRequest()
{
    TransactionType = TransactionTypes.PreAuthorization,
    PaymentMethod = new PaymentRequestMethod()
    {
        PaymentType = PaymentTypes.Card,
        PAN = "4242424242424242",
        ExpMonth = "10",
        ExpYear = "2020"
    },
    Amount = 100,
    Currency = "352",
    OrderId = "IntegrTest01",
    TransactionDate = DateTime.Now
};

RPGClient client = new RPGClient("<PRIVATE_ACCESS_TOKEN>", "<SERVICE_URL>");
PaymentTransactionResponse response = await client.Payment.CreateAsync(req);

Example - Charging with Token

curl <SERVICE_URL>/api/payment \
  -u <PRIVATE_ACCESS_TOKEN>: \
  -d "TransactionType=PreAuthorization" \
  -d "Amount=100" \
  -d "Currency=352" \
  -d "TransactionDate=2015-10-10T11:00:00" \
  -d "OrderId=TEST00000001" \
  -d "PaymentMethod.PaymentType=TokenSingle" \
  -d "PaymentMethod.Token=<SINGLE_USE_TOKEN>"

PaymentRequest req = new PaymentRequest()
{
    TransactionType = TransactionTypes.PreAuthorization,
    PaymentMethod = new PaymentRequestMethod()
    {
        PaymentType = PaymentTypes.TokenSingle,
        Token = "<SINGLE_USE_TOKEN>",
    },
    Amount = 100,
    Currency = "352",
    OrderId = "IntegrTest01",
    TransactionDate = DateTime.Now
};

RPGClient client = new RPGClient("<PRIVATE_ACCESS_TOKEN>", "<SERVICE_URL>");
PaymentTransactionResponse response = await client.Payment.CreateAsync(req);

Capture PreAuthorization

To finalize a sale that was previously pre authorized you can perform a PUT request to /api/payment/<TRANSACTION_ID>/capture where <TRANSACTION_ID> is the id of the PreAuthorization transaction.

Example - Capture PreAuthorization

curl <SERVICE_URL>/api/payment/<TRANSACTION_ID>/capture \
  -u <PRIVATE_ACCESS_TOKEN>: \
  -X PUT \
  -d ""

RPGClient client = new RPGClient("<PRIVATE_ACCESS_TOKEN>", "<SERVICE_URL>");
PaymentCaptureResponse response = await client.Payment.CaptureAsync("<TRANSACTION_ID>");
  

Cancel PreAuthorization

To cancel an existing PreAuthorization you can perform a PUT request to /api/payment/<TRANSACTION_ID>/cancel where <TRANSACTION_ID> is the id of the PreAuthorization transaction.

Example - Cancelling PreAuthorization

curl <SERVICE_URL>/api/token/single/<TOKEN> \
  -u <PRIVATE_ACCESS_TOKEN>: \
  -X DELETE

RPGClient client = new RPGClient("<PRIVATE_ACCESS_TOKEN>", "<SERVICE_URL>");
PaymentCancelResponse response = await client.Payment.CancelAsync("<TRANSACTION_ID>");
  

Refund Transaction

To refund an existing transaction you can perform a PUT request to /api/payment/<TRANSACTION_ID>/refund where <TRANSACTION_ID> is the id of the transaction. NOTE: If Amount is not specified this will always try to refund the full amount of the original transaction. (See Partially refunding transaction)

Example - Refunding Transaction

curl <SERVICE_URL>/api/payment/<TRANSACTION_ID>/refund \
  -u <PRIVATE_ACCESS_TOKEN>: \
  -X PUT \
  -d ""

RPGClient client = new RPGClient("<PRIVATE_ACCESS_TOKEN>", "<SERVICE_URL>");
PaymentRefundResponse response = await client.Payment.RefundAsync("<TRANSACTION_ID>");
  

Partially refunding transaction

Refunds with amounts lower than the original transaction amount can be performed. Multiple refunds can be done as long as the total amount of the refunds do not exceed the amount of the original transactions.

Example - Partially refunding transaction

curl <SERVICE_URL>/api/payment/<TRANSACTION_ID>/refund \
  -u <PRIVATE_ACCESS_TOKEN>: \
  -X PUT \
  -d "PartialAmount=100"

Get transaction info

Getting transaction information can be done by performing a GET request to /api/payment/<TRANSACTION_ID> where <TRANSACTION_ID> is the id of the transaction. This request will return a TransactionInfo object.

Example - Get Transaction

curl <SERVICE_URL>/api/payment/<TRANSACTION_ID> \
  -u <PRIVATE_ACCESS_TOKEN>:

RPGClient client = new RPGClient("<PRIVATE_ACCESS_TOKEN>", "<SERVICE_URL>");
PaymentTransactionResponse response = await client.Payment.GetTransactionAsync("<TRANSACTION_ID>");