• France
Merchant Back Office
assistance
FAQContact support
Search
Categories
Tags
English
French
English
Homepage
Use cases
Create a payment
Create an installment payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
Snippets
Payment methods
Plugins
Guides
Merchant Back Office
Functional guides

Analyzing the response

orderStatus

Description: Simplified transaction status.

Possible values:
  • PAID : The order has been paid.
  • UNPAID : The order has not been paid.
  • RUNNING : The order is in progress.

E.g.:PAID

orderCycle

Description: Defines if the order is open (OPENthe payment is authorized), or closed (CLOSED, it can no longer be modified).

Possible values:
  • OPEN : The order is in progress. You must store the cart as there may be further payment attempts.
  • CLOSEDThe order is either fully paid or the last attempt was refused (in which case you must generate a new formToken).

E.g.:CLOSED

shopId

Description: Shop ID

E.g.:12345678

orderDetails.mode

Description: Transaction creation mode.

Possible values:
  • TEST : for a test order
  • PRODUCTION : for a real order

E.g.:PRODUCTION

orderDetails.orderId

Description: Order reference.

E.g.:myOrderId-1234

customer.reference

Description: Buyer ID on the merchant website.

E.g.:MyReference-123456

customer.email

Description: Buyer’s e-mail address.

E.g.:sample@example.com

cusotmer.billingDetails

Description: Object containing details of the billing address.

customer.shippingDetails

Description: Object containing the details of the billing address.

customer.shoppingCart

Description: Object containing the details of the shopping cart.

transaction.paymentMethodToken

Description: Token of the payment method.

E.g.:7d7eeb9794ff473e8843c3ef4bb690b5

transaction.amount

Description: Payment amount in the smallest currency unit .

E.g.: 4525 for 4525 XPF

transaction.currency

Description: Payment currency according to the ISO 4217 alpha-3 standard.

E.g.: "XPF”.

transactions.transactionDetails.acquirerNetwork

Description: Acquirer network code. Valued at OSB_PRIV.

transactions.transactionDetails.cardDetails.effectiveBrand

Description: Card brand.

Possible values:

  • PRV_BDP: Bank of Polynesia card.
  • PRV_BDT: Bank of Tahiti card.
  • PRV_OPT: MARARA card.
  • PRV_SOC: Socredo card.
  • PRV_SMART_CARD: Smart Card card.

E.g.:PRV_OPT

transactions.uuid

Description: Unique transaction identifier generated by the payment gateway.

This identifier is then used for transaction management using the REST Web Service or via the Back Office.

E.g.:aab72593d0ce428ca6dd73ac7293d92d

transactions.transactionDetails.cardDetails.manualValidation

Description: Transaction validation mode.

Possible values:
  • NO : Automatic validation by the payment gateway.
  • YES : Manual validation by the merchant.

E.g.:NO

transactions.transactionDetails.cardDetails.expectedCaptureDate

Description: Date of capture at the bank expressed in ISO 8601 format.

E.g.:2021-09-09T07:46:06+00:00

transactions.transactionDetails.cardDetails.authorizationResponse.authorizationResult

Description: Return code of the authorization request.

E.g.:00

transactions.transactionDetails.cardDetails.authenticationResponse.status

Description: Authentication status of the cardholder.

Possible values:
  • SUCCESS : Authentication success
  • FAILED : Authentication error
  • UNAVAILABLE : The authentication could not be completed (technical error, etc.)

E.g.:SUCCESS

© 2025 {'|'} All rights reserved to PayZen by OSB
25.22-1.11