Starkbank¶

For companies that believe the future is today

Set up Account Provider account¶

Step 1: Create Provider account¶

To create an account send connection request at the starkbank.com → Contact sales 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
Private Key

Connect Provider Account¶

Step 1. Connect Provider account at the Corefy Dashboard¶

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

Connect

Enter credentials:

starkbank__project_id → Project ID
starkbank__private_key → Private Key
Test Mode → true/false

Success

You have connected Starkbank Payout Gateway Provider account!

Connect Merchant Account¶

Step 1. Connect Merchant account at the Corefy Dashboard¶

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

Connect

Enter credentials:

starkbank__project_id → Project ID
starkbank__private_key → Private Key
Test Mode → true/false

Success

You have connected Starkbank Payment Gateway merchant account!

API examples:¶

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

PAYMENT

POST /api/commerce/payment-invoices
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "pix_brl_hpp",
      "commerce_account": "Hello World",
      "currency": "BRL",
      "amount": 5,
      "flow": "charge",
      "gateway_options": {
        "cardgate": {
          "tokenize": false
        }
      },
      "test_mode": false,
      "options": {
        "allow_partially": false,
        "bypass_hpp": false,
        "send_operation_context_on_return": false
      },
      "reference_id": "683e34ef-f981-42ec-a7de-06c7d03142dd",
      "service_fields": {
        "cpf_number": "012.345.678-90",
        "payer_first_name": "Test",
        "payer_last_name": "Test"
      }
    }
  }
}

Minimum data set to create a payout invoices for pix_brl service¶

PAYOUT

POST /api/commerce/payout-invoices
{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "pix_brl",
      "commerce_account": "Hello World",
      "currency": "BRL",
      "amount": 1,
      "test_mode": false,
      "reference_id": "ab765f27-840e-41b9-9c1c-2b5238a8cd19",
      "fields": {
        "cpf_number": "11968409700",
        "beneficiary_name": "João",
        "beneficiary_lastname": "Francisco",
        "bank_isbp_code": "18236120",
        "account_number": "41818451-6",
        "bank_branch_code": "0001"
      },
      "options": {
        "attempts_limit": 0,
        "split_mode": false,
        "allow_partially": false,
        "auto_process": false
      }
    }
  }
}

Provider Options¶

Provider_Options

Customer CPF validation
- enables you to set up additional CPF account verification security to boost payments
  - If the option is activated: everything works as it works now
  - If the option is selected: We will not perform additional verification of the CPF account

Question

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