Example: Enabling the Payments Data Set

In addition to the Provisioned orders data set for the report, you can enable Payments. This data set includes all payment and refund transactions with the associated information of customer accounts, payment methods, and transactions.

Important: You cannot disable the Payments data set after enabling it.

To enable the Payments data set with English, German, and Spanish localization, perform the following steps:

1. Create two files with the following names and contents:
   

   Note: You can use a respective JSON file from this archive.

2. 1. payment.json

      {
      "aps": {
          "type": "http://www.odin.com/rde/global-data-set/1.0"
        },
      "dataSetType": "payment",
      "title": {
      	"en_US": "Payments",
      	"de_DE": "Zahlungen",
      	"es_ES": "Pagos"
      },
      "description": {
      	"en_US": "All payment and refund transactions with the associated information of customer accounts, payment methods and transactions.",
      	"de_DE": "Alle Zahlungs- und Rückerstattungstransaktionen mit den dazugehörigen Informationen über die Konten, Zahlungsmethoden und Transaktionen eines Kunden.",
      	"es_ES": "Todas las transacciones de pago y reembolso, junto con la información asociada de las cuentas, los métodos de pago y las transacciones electrónicas de los clientes."
      }
      
      }

      Use the table below for localization reference:

      Important: Save this file in UTF-8 encoding.

      Language	Locale	Title	Description
      English	en_US	Payments	All payment and refund transactions with the associated information of customer accounts, payment methods and transactions.
      German	de_DE	Zahlungen	Alle Zahlungs- und Rückerstattungstransaktionen mit den dazugehörigen Informationen über die Konten, Zahlungsmethoden und Transaktionen eines Kunden.
      Spanish	es_ES	Pagos	Todas las transacciones de pago y reembolso, junto con la información asociada de las cuentas, los métodos de pago y las transacciones electrónicas de los clientes.
      French	fr_FR	Paiements	Toutes les transactions de paiement et de remboursement avec les informations associées aux comptes d'un client, les modes de paiement et les transactions.
      Italian	it_IT	Pagamenti	Tutte le transazioni di pagamento e rimborso con le informazioni associate relative ai conti, ai metodi di pagamento e alle transazioni di un cliente.
      Japanese	ja_JP	支払	顧客のアカウント、支払方法、および取引の関連情報がある、すべての支払と返金の取引。
      Dutch	nl_NL	Betalingen	Alle betalings- en terugbetalingstransactie met de bijbehorende informatie van de klantaccounts, -betaalmethoden en -transacties.
      Brazilian Portuguese	pt_BR	Pagamentos	Todas as transações de pagamento e reembolso com as informações associadas das contas, métodos de pagamento e transações de um cliente.
      Russian	ru_RU	Платежи	Все платежи и операции по возврату денежных средств с соответствующими сведениями об учетных записях, способах оплаты и транзакциях.

      Note: You can add or delete locales later, as described in this example.

   2. payments.sh

      rde_json="`cat payment.json`"
      aps_token="`cat aps.token`"
      cmd="curl -v -X POST   -H \"Content-Type: application/json\" -H \"APS-Token: $aps_token\"  --data-binary '"$rde_json"'  \"https://brand_domain/aps/2/resources\" "
      echo $cmd
      eval $cmd
      printf '\n'

      Note: brand_domain is the branded domain name, for example: brand.com

3. Get an APS token of the provider:
   1. Log in to the Operations PCP.
   2. Go to System > Settings > User APS tokens > admin.
   3. Copy the displayed text and paste it in the newly created aps.token file.
4. Save these three files on the CloudBlue Commerce management node, for example, in the /usr/local/bin directory.
5. Run the payments.sh script to enable the Payments data set.