Skip to content

Logo

Prosperos

Supports in this guide: Payments

Provider website: prosperos.io (returned a temporary "service unavailable" response at the time of writing; confirm it's back up before sharing it)

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

  1. Get your credentials (from Prosperos)
  2. Connect in Dashboard
  3. Send an API request

Prerequisites: get from Prosperos

Contact your Prosperos account manager to get your account verified and receive the following credentials.

  • API Key -> Corefy field api_key.
  • API Type -> Corefy field api_type -> Server to Server or Direct Post - check with your account manager which one your Prosperos account is set up for.
  • S2S Token (required if API Type is Server to Server) -> Corefy field s2s_token -> used instead of the API Key to authenticate card-submission requests in this mode.
  • Brand ID -> Corefy field brand_id.
  • Webhook Public Key (optional) -> Corefy field webhook_public_key -> used to verify callback notifications from Prosperos, if your account requires it.

Note

API Type controls how card data reaches Prosperos: with Server to Server, Corefy's own backend submits the card data to Prosperos; with Direct Post, the customer's browser/checkout layer submits it directly to Prosperos instead. Either way, you send requests to Corefy's API the same way - this only affects how card data travels behind the scenes.

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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • API Key
  • API Type
  • S2S Token (required if API Type is Server to Server)
  • Brand ID
  • Webhook Public Key (optional)

Choose Currency / Features; check with your Corefy account manager which are enabled for your account.

Success

You have connected Prosperos H2H Merchant account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice; card data itself is collected and submitted separately by Corefy's checkout/SDK layer, not as part of this request. Prosperos may return a 3D Secure challenge redirect depending on the card. CVV is always required - non-CVV sales aren't supported.

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8e3dbbb0-17af-4c9a-bedb-93bdac6900a2",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10
    }
  }
}

Note

This connector currently supports EUR only.

Payment - MAX

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "date_of_birth": "1990-01-01",
        "individual_tax_id": "12345678901",
        "address": {
          "country": "FR",
          "region": "IDF",
          "city": "Paris",
          "full_address": "1 Main street",
          "post_code": "75000"
        }
      }
    }
  }
}

customer is entirely optional for a direct card sale - everything is only used to enrich the 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

No Options or Constants are configured for this connector.

Refunds

Prosperos supports partial refunds, but only one refund per payment (no multiple partial refunds against the same payment).

Additional info

  1. Callback routing is automatic - Corefy generates the callback/return URLs per transaction, nothing to configure in Prosperos's own back-office.
  2. No payouts - this connector does not support payouts through Corefy.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify API Key/S2S Token/Brand ID for the selected API Type
  • Not sure which API Type to pick? -> ask your Prosperos account manager which mode (Server to Server or Direct Post) your account is configured for
  • Refund fails on a second attempt -> only one refund is allowed per payment
  • Currency or service is not supported -> confirm allowed currencies/features in your Prosperos account and in Corefy

Question

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