RYVYL¶

WE ARE RYVYL™

We leverage the security of blockchain ledger with near real-time data insights to offer a multitude of payment solutions across different industries.

Website: www.ryvyl.com

Set up Account H2H merchant account¶

Step 1: Create Merchant Account¶

To create an account send connection request at the www.ryvyl.com/contact-us 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:

ryvyl__mid → Merchant ID
ryvyl__mid_qualifier → MID Qualifier
ryvyl__api_user_name → API User Name
ryvyl__api_password → API Password
ryvyl__api_url → API URL
ryvyl__test_mode → true/false
ryvyl__currency → choose currency (You can set these parameters according to available currencies and features for your RYVYL 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 RYVYL Provider Overview page in 'New connection' section and choose H2H Merchant account option to open Connection form.

Connect

Enter credentials:

Merchant ID
MID Qualifier
API User Name
API Password
API URL
Test mode
Currency

Success

You have connected RYVYL H2H merchant account!

API examples:¶

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

SALE
POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"payment_card_usd_hpp",
      "commerce_account":"hello_world",
      "currency":"USD",
      "amount":20,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"d2eda25b-3287-45ec-98dc-7a8858aa1a3a",
        "name":" Test Card",
        "email":"[email protected]",
        "phone":"+442045763413",
        "address":{
          "full_address":"Sidney",
          "country":"AU",
          "city":"Sidney",
          "post_code":"777777"
        }
      },
      "test_mode":true,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "reference_id":"827ea596-14ad-4f4a-b876-a8d5410fa25c",
      "service_fields":[
      ]
    }
  }
}

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

SALE
POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"payment_card_usd_hpp",
      "commerce_account":"hello_world",
      "currency":"USD",
      "amount":20,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"13d493e2-8834-4772-890b-ffaa7c58dfac",
        "name":"Test Card",
        "email":"[email protected]",
        "phone":"+442045763413",
        "date_of_birth":"2000-01-10",
        "address":{
          "full_address":"Some street",
          "country":"US",
          "region":"CA",
          "city":"Los Angeles",
          "post_code":"777777"
        }
      },
      "test_mode":true,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "reference_id":"9941448f-5444-4c19-b657-c1f400fc3ccb",
      "service_fields":[
      ]
    }
  }
}

Constants¶

Сonstants

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:

FIRST_NAME → customer [first_name]
LAST_NAME → customer [last_name]
ADDRESS → customer [address] [address]
CITY → customer [address] [city]
ZIP → customer [address] [zip]
COUNTRY → customer [address] [country]
EMAIL → customer [email]
PHONE → customer [phone]

Question

"Still looking for help connecting your RYVYL account?" Please contact our support team!