Skip to content

Logo

StreamPayments

Seamless Merchant Payments.

Supports in this guide: Payments

Provider website: streampayments.com

What you need to do for start processing transactions (brief summary)

  1. Choose account type
  2. Get your credentials (from StreamPayments)
  3. Connect in Dashboard
  4. Send an API request

Choose account type

StreamPayments can be connected in different ways (depending on your needs):

  • If you do card payments -> choose H2H Merchant account

If you are not sure which one to use, confirm with your Corefy account manager.

Prerequisites: get from StreamPayments

Get the following values for your StreamPayments project/account:

  • Terminal Key -> Corefy field terminal_key -> example: tk_9f8c1a2b3d4e -> where to find: StreamPayments backoffice / issued by StreamPayments manager
  • API Key -> Corefy field api_key -> example: sk_live_51H8xJ2eZvKYlo2C -> where to find: StreamPayments backoffice / issued by StreamPayments manager
  • API URL -> Corefy field api_url -> example: https://your-bridge-server.example.com/api/ -> where to find: your own bridge server's endpoint (only needed if this connector routes through your own bridge)

Important

Be sure to check with the manager if you require to provide a white list of IPs, and if so, specify IP addresses from the Corefy list.

Payments processing (connect H2H Merchant account, create payment-invoice)

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

Open StreamPayments in the provider directory and press Connect at StreamPayments Provider Overview page in the New connection section. Choose H2H Merchant account.

Step 2 - Fill in fields and select settings

  • Terminal Key
  • API Key
  • API URL (optional — override the default provider URL if using this connector as a bridge)
  • Save Instant Token -> (enable if you plan to use instant/recurring payments)
  • Test Mode -> (enable if you are using sandbox credentials)

Choose Currency and Features. You can set these parameters according to available currencies and features for your StreamPayments account, but it is necessary to check details of the connection with your Corefy account manager.

Success

You have connected StreamPayments H2H Merchant account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice.

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 1,
      "flow": "charge",
      "gateway_options": {
        "cardgate": {
          "tokenize": ""
        }
      },
      "customer": {
        "reference_id": "55041b5b-adfd-4073-a92b-fd8b495a4cc1",
        "email": "johnsmith@gmail.com"
      },
      "test_mode": true,
      "options": {
        "allow_partially": false,
        "bypass_hpp": false,
        "send_operation_context_on_return": false
      },
      "reference_id": "86e68af6-6b95-4cc0-be16-e4df8044604c",
      "service_fields": []
    }
  }
}
customer.email is optional — StreamPayments doesn't reject a request missing it, it's just carried over from a real submitted request.

Payment - MAX

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 1,
      "flow": "charge",
      "gateway_options": {
        "cardgate": {
          "tokenize": ""
        }
      },
      "customer": {
        "reference_id": "bc75bc54-5023-4f98-8c0d-ec5ed7e8f380",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+3806771234567",
        "address": {
          "full_address": "Shevchenko 123",
          "country": "BG",
          "region": "Sofia",
          "city": "Sofia",
          "street": "Shevchenko st",
          "post_code": "1000"
        }
      },
      "test_mode": true,
      "options": {
        "allow_partially": false,
        "bypass_hpp": false,
        "send_operation_context_on_return": false
      },
      "reference_id": "08f5e97c-1170-4bda-9625-3bde3c6dcd20",
      "service_fields": []
    }
  }
}

Extended request (MAX)

Why add extra fields (typical reasons): - Provide additional customer details for compliance/reconciliation - Positively influence conversion rate - Include optional fields required by your specific flow

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify credentials for the selected environment and account type
  • Currency or service is not supported -> confirm allowed currencies/features in your StreamPayments account and in Corefy
  • Missing required fields -> provide missing request fields in the API request
  • Not sure which account type to use? -> ask your Corefy account manager
  • 403 Forbidden -> check that your server IP is in the provider's IP allowlist

Question

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