support
Back to documentation
Search
Categories
Tags
main parametersexpand all
amount
required
currency
required
uuid
required
orderId
recommended
general transaction options
comment
metadata
[1]
:
card related options
cardDuplicate
manualValidation
captureDelay
new properties
acquirerTransientData
[1]
:
Try me
Documentation

Transaction/Duplicate Web Service

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.secure.osb.pf/api-payment/V4/Transaction/Duplicate

The Transaction/Duplicate REST Web Service allows to create a new transaction based on an existing transaction while maintaining the same characteristics (example: payment method, buyer details).

Transactions that can be duplicated must have one of the following detailedStatus :

  • CAPTURED
  • EXPIRED
  • CANCELED
  • REFUSED

The duplication of refused transactions made with Mastercard cards (Mastercard, Maestro, Mastercard Debit) is forbidden when the reason for refusal is mentioned on the list below:

  • 04 - Capture card
  • 41 - Lost card
  • 14 - Invalid card number
  • 43 - Stolen card
  • 15 - Invalid issuer
  • 54 - Expired card

Plus d'infos sur les statuts, consultez : Cycle de vie d'une transaction.

Consultez les paramètres de la réponse Transaction.

Input parameters

amount

Payment amount in the smallest currency unit.

Example: 30050 for XPF 30050.

Format

currency

Payment currency. Alphabetic code in uppercase according to alpha-3 (ISO 4217).

Example: "XPF" for the CFP franc.

Format

Possible values

. The possible values are:

Currency ISO 4217 ENCODING Fractional unit
Australian dollar (036) AUD 2
Chinese renminbi (156) CNY 1
Djibouti Franc (262) DJF 0
Euro (978) EUR 2
Fiji Dollar (242) FJD 2
Pound Sterling (826) GBP 2
Hong Kong dollar (344) HKD 2
Japanese yen (392) JPY 0
Cambodian riel (116) KHR 0
Laotian Kip (418) LAK 0
New Zealand dollar (554) NZD 2
Solomon Islands Dollar (090) SBD 2
Thai baht (764) THB 2
US dollar (840) USD 2
Vatu of the Vanuatu Islands (548) VUV 0
CFP Franc (953) XPF 0

uuid

Unique transaction ID generated by the payment gateway.

Format

orderId

Order reference defined by the Merchant.Does not support UTF-8 characters.

Format

comment

Public comment.

Format

metadata

Custom values linked to the transaction, in JSON format.

Example of a call

For example, to pass a custom value, add the following to your query:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

This value will be returned in the newly created transaction object.

You can also use the metadata “ orderInfo1 ”, “ orderInfo2 ” and “ orderInfo3 ” to send complementary information about the order.

This data can be found later in the Extra tab of the transaction details via your Merchant Back Office.

Format

captureDelay

Path: cardDuplicate.captureDelay

Delay to be applied to the capture date.

Description

Indicates the delay (in days) before the capture.

If this parameter is not passed, then the default value set in the Merchant Back Office will be used.

It can be set in the Merchant Back Office by all authorized persons.

If the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

Format

manualValidation

Path: cardDuplicate.manualValidation

Transaction validation mode.

Format

Possible values

. The possible values are:

value Description
NO Automatic validation by the payment gateway.
YES Manual validation by the Merchant.
null Default configuration of the selected shop (configurable in the Merchant Back Office).

Response reference

The web service returns the following object:

Response Context
Transaction Object containing transaction details.

See response reference for more information.