Paymentz¶

Website: paymentz.co.uk

Set up Account H2H merchant account¶

Step 1: Create Merchant Account¶

To create an account send connection request at the paymentz.co.uk/partner or contact manager directly. Submit the required documents to verify your account and gain access.

Step 2: Get required credentials¶

Credentials that have to be issued:

• paymentz__product_name → Product name
• paymentz__merchant_private_key → Merchant private key
• paymentz__currency → choose currency (You can set these parameters according to available currencies and features for your Paymentz wallets and services, but it's necessary to check details of the connection with your Corefy account manager.)

Connect Merchant Account¶

Step 1. Connect H2H account at the Corefy Dashboard¶

Press Connect at Paymentz Provider Overview page in 'New connection' section and choose H2H Merchant account option to open Connection form.

Enter credentials:

• Product name
• Merchant private key

API examples:¶

Minimum data set to create a payment invoices for payment_card_eur_hpp service¶

SALE

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"payment_card_eur_hpp",
      "commerce_account":"Hello World",
      "currency":"EUR",
      "amount":1,
      "reference_id":"e9745af4-4b0b-4adb-ae8e-63cef6e07b2d",
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"8ce9c51c-6a72-4f73-aa60-380967ef9645",
        "email":"[email protected]",
      }
    },
    "test_mode":false,
    "options":{
      "allow_partially":false,
      "bypass_hpp":false,
      "send_operation_context_on_return":false
    },
    "service_fields":[
    ]
  }
}
}

Maximum data set to create a payment invoices for payment_card_eur_hpp service¶

SALE

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"payment_card_eur_hpp",
      "commerce_account":"Hello World",
      "currency":"EUR",
      "amount":1,
      "reference_id":"e9745af4-4b0b-4adb-ae8e-63cef6e07b2d",
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"8ce9c51c-6a72-4f73-aa60-380967ef9645",
        "name":"Test Test",
        "email":"[email protected]",
        "phone":"444444****4444",
        "date_of_birth":"2000-01-01",
        "individual_tax_id":"123456789",
        "address":{
          "full_address":"London Test 357",
          "country":"GB",
          "region":"London",
          "city":"London",
          "street":"Test 357",
          "post_code":"000357"
        }
      },
      "test_mode":false,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "service_fields":[
      ]
    }
  }
}

Constants¶

If some parameters are not sent in the transaction creation request, they will take the values from the set constants.

Here is a list of constants with their corresponding parameters:

• EMAIL → customer [email]

Provider Options¶

• ignore_callback
  • for cascading to work correctly, we exclude the possibility of finalizing payments using asynchronous callbacks, ignore the callback, do not change the status of the transaction on it in any way and rely only on the status request for finalization (Reconciliation)

Default values¶

If some parameters are not passed in the request to create a transaction and the corresponding constants have no values, then default values will be passed instead.

Here is the list of default values with their corresponding parameters:

• EMAIL → jonhdoe@example.com