Prime

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields (provider -> Corefy)

• Merchant Account Name -> merchant_account_name (a label you choose yourself, not issued by Prime)
• API Key -> api_key
• API Secret -> api_secret

First request to Corefy API (MIN)

What it does: creates a payout-invoice. One payout route is available: service payment_card_eur, method Card payout, currency EUR.

Payout - MIN

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "payment_card_eur",
      "currency": "EUR",
      "amount": 10,
      "fields": {
        "card_number": "411111******1111"
      },
      "context": {
        "card": {
          "exp_month": "01",
          "exp_year": "27"
        }
      }
    }
  }
}

fields [card_number] is the payout destination, and context [card] carries the card's expiry date - Prime may decline the payout if either is missing, and neither has a Dashboard Constant to fall back on. Prime also requires customer [reference_id], email, name, phone, date_of_birth, address and metadata [ip], but every one of these can be set as a Constant instead (see below) - Corefy sends the Constant whenever the request doesn't include the field, so a route with all of them configured can omit customer from the request entirely, as shown here.

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "payment_card_eur",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "85af8385-d00e-4f58-ab1f-3a527fdf2d3b",
        "name": "John Doe",
        "email": "johndoe@email.com",
        "phone": "+441234567890",
        "date_of_birth": "2000-02-02",
        "address": {
          "full_address": "123 Baker street",
          "country": "GB",
          "city": "London",
          "street": "123 Baker street",
          "post_code": "NW16XE"
        },
        "metadata": {
          "ip": "203.0.113.10"
        }
      },
      "fields": {
        "card_number": "411111******1111"
      },
      "context": {
        "card": {
          "exp_month": "01",
          "exp_year": "27"
        }
      }
    }
  }
}

Send these fields directly in the request when you have accurate per-customer data - a value in the request always takes priority over the configured Constant. Prime also requires a browser fingerprint and user agent on its side, but Corefy generates and sends both of these for you, so they're not part of your request.

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

Constants (fallback fields)

Constants are static values that Corefy can send to Prime instead of dynamic data from your API request, when those fields are missing in the request.

Priority (predictable rule):

1. If a value is present in the request -> Corefy uses the request value
2. Else if the constant is set -> Corefy uses the constant
3. Else -> the field is left out of the request to Prime (Prime may decline the payout if it's one of the required fields)

Currently available constants (constant -> Corefy API field)

General:

• TTL -> not present on the payout-invoice request itself; sets how many seconds Prime waits before the payout request expires. Defaults to 3600 seconds if the constant isn't set.

Customer:

• CUSTOMER_ID -> customer.reference_id
• CUSTOMER_EMAIL -> customer.email
• CUSTOMER_FIRST_NAME -> customer.name (first part of the name)
• CUSTOMER_LAST_NAME -> customer.name (last part of the name)
• CUSTOMER_PHONE -> customer.phone
• CUSTOMER_IP -> customer.metadata.ip
• CUSTOMER_DATE_OF_BIRTH -> customer.date_of_birth

Customer address:

• CUSTOMER_ADDRESS_FULL -> customer.address.full_address
• CUSTOMER_ADDRESS_COUNTRY -> customer.address.country
• CUSTOMER_ADDRESS_CITY -> customer.address.city
• CUSTOMER_ADDRESS_STREET -> customer.address.street
• CUSTOMER_ADDRESS_ZIP -> customer.address.post_code