GetaPay¶

Website: getapay.io

Set up Account¶

Step 1: Create merchant account¶

To create an account send connection request at the getapay.io 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:

• project_id
• secret_key

Connect H2H Merchant Account¶

Step 1. Connect H2H account at the Corefy Dashboard¶

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

Enter credentials:

• project_id → Project ID
• secret_key → Secret Key
• currency → choose currency (You can set these parameters according to available currencies and features for your GetaPay wallets and services, but it's necessary to check details of the connection with your Corefy account manager.)

You have connected GetaPay H2H merchant account!

API examples:¶

Maximum data set to create a transaction¶

POST /api/commerce/payment-invoices HTTP/1.1

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_usd_hpp",
      "commerce_account": "hello world",
      "currency": "USD",
      "amount": 5,
      "reference_id": "45842402-0605-4f45-9738-8c7e6a6a689f",
      "flow": "charge",
      "customer": {
        "reference_id": "0da5e981-782f-44f5-bc37-35345f2db1be",
        "email": "[email protected]",
        "phone": "79161111102",
        "address": {
          "full_address": "95 Richmond Road",
          "country": "GB",
          "region": "Richmond",
          "city": "London",
          "post_code": "SW198TQ"
        }
      },
      "test_mode": false,
      "options": {
        "allow_partially": false
      }
    }
  }
}

Minimum data set to create a transaction¶

POST /api/commerce/payment-invoices HTTP/1.1

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_usd_hpp",
      "commerce_account": "hello world",
      "currency": "USD",
      "amount": 5,
      "reference_id": "45842402-0605-4f45-9738-8c7e6a6a689f",
      "flow": "charge",
      "test_mode": false,
      "options": {
        "allow_partially": false
      }
    }
  }
}

Connect Provider Account¶

Step 1. Connect Provider account at the Corefy Dashboard¶

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

Enter credentials:

• project_id → Project ID
• secret_key → Secret Key

You have connected GetaPay Provider account!

API examples:¶

Maximum data set to create a payout¶

POST /api/commerce/payout-invoices HTTP/1.1

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "payment_card_eur",
      "commerce_account": "Hello World",
      "currency": "EUR",
      "amount": 1,
      "reference_id": "606da225-04b9-4633-8156-75c0a13b10c6",
      "customer": {
        "reference_id": "eda6b396-5c2f-4453-987d-5a7ca2d42264",
        "name": "John Wick",
        "email": "[email protected]",
        "phone": "31331123123"
      },
      "test_mode": false,
      "fields": {
        "card_number": "424449******8988"
      },
      "options": {
        "attempts_limit": 0,
        "split_mode": false,
        "allow_partially": false,
        "auto_process": false
      }
    }
  }
}

Minimum data set to create a payout¶

POST /api/commerce/payout-invoices HTTP/1.1

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "payment_card_eur",
      "commerce_account": "Hello World",
      "currency": "EUR",
      "amount": 1,
      "reference_id": "606da225-04b9-4633-8156-75c0a13b10c6",
      "test_mode": false,
      "fields": {
        "card_number": "424449******8988"
      },
      "options": {
        "attempts_limit": 0,
        "split_mode": false,
        "allow_partially": false,
        "auto_process": false
      }
    }
  }
}

Additional information¶

Constants for H2H Merchant account¶

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:

• FULL_ADDRESS → customer [address] [fullAddress]
• REGION → customer [address] [region]
• COUNTRY → customer [address] [country]
• CITY → customer [address] [city]
• POST_CODE → customer [address] [postCode]
• EMAIL → customer [email]
• PHONE → customer [phone]

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:

• customer [address] [fullAddress] → '95 Richmond Road'
• customer [address] [country] → 'GB'
• customer [address] [city] → 'London'
• customer [address] [postCode] → 'SW198TQ'
• customer [address] [region] → 'Richmond'
• customer [email] → 'example@gmail.com'
• customer [phone] → '79161111102'

Constants for Provider account¶

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:

• NAME → customer [name]
• EMAIL → customer [email]
• PHONE → customer [phone]

Please contact our support team!