Skip to content

Logo

PayPlanet

Supports in this guide: Payments, Payouts

Provider website: pay-planet.com


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

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

Choose account type

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

  • If you do H2H card payments (card data sent directly) -> choose H2H Merchant account
  • If you do local Latin American payment methods (bank transfer, PSE, Nequi, Bre-B) or payouts -> choose Provider account

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


Prerequisites: get from PayPlanet

Contact your PayPlanet account manager to get your account verified and receive the following credentials (the same two values are used for both account types).

  • API Key -> Corefy field api_key.
  • Secret Key -> Corefy field secret_key -> used to sign every request.

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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • API Key
  • Secret Key
  • Test Mode -> (enable if you are using sandbox credentials)

Choose Currency and Features. USD and UZS are confirmed; check with your Corefy account manager which are enabled for your account.

Success

You have connected PayPlanet 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.

Payment - MIN

POST /api/payment-invoices

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

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123"
      }
    }
  }
}

customer is optional - only customer.reference_id is actually forwarded (as the buyer's remote ID), everything else about the customer is skipped on this flow. CVV is required for USD; for UZS specifically, CVV is optional - a placeholder is used internally if you don't collect it.

Important

This connector doesn't support refunds through Corefy.


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 flow.


Payments processing (connect Provider account, create payment-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • API Key
  • Secret Key
  • Test Mode -> (enable if you are using sandbox credentials)

Choose Currency / Features - this connector focuses on Latin American local payment methods - see Additional info for the full list.

Success

You have connected PayPlanet Provider account!


First request to Corefy API (MIN)

What it does: creates a payment-invoice and returns a redirect link to the chosen local method's payment page.

Payment - MIN

POST /api/payment-invoices

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

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "pse_cop_hpp",
      "currency": "COP",
      "amount": 50000,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "phone": "+15551234567",
        "address": {
          "street": "1 Main street"
        }
      },
      "fields": {
        "document_type": "CC",
        "document_number": "1234567890"
      }
    }
  }
}

customer is optional on every local method, but which fields each one actually forwards differs - see Additional info for the breakdown. fields.document_type/fields.document_number (Colombian ID type/number) apply where relevant.


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 flow.


Payouts processing (connect Provider account, create payout-invoice)

Connect Provider account in Corefy Dashboard

Uses the same Provider account connection as Payments above - one connection covers both directions, there's nothing extra to fill in for payouts specifically.


First request to Corefy API (MIN)

What it does: creates a payout-invoice and sends funds to a card or a local bank/instant-payment account.

Payout - MIN (card)

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "0dde9e79-2c64-4703-adaf-93d710633401",
      "service": "payment_card_usd",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

fields.card_number is required. This connector also supports card payouts in KZT (use payment_card_kzt) - for KZT specifically, customer.reference_id is also used, and the card's expiry/holder come from the stored card data, not from fields.

Payout - MIN (Colombian bank transfer)

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "3c6d2f8e-8a2a-4e7a-9b1a-2f6a7b9c0d1e",
      "service": "bank_transfer_cop",
      "currency": "COP",
      "amount": 50000,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567"
      },
      "fields": {
        "document_type": "CC",
        "document_number": "1234567890",
        "account_number": "1234567890",
        "bank_code": "001",
        "bank_name": "Bancolombia",
        "bank_account_type": "savings"
      }
    }
  }
}

The exact required subset of fields.* varies by destination method - see Additional info for the field list per country.


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 flow.


Additional info

  1. Callback routing is automatic - Corefy generates the callback URL per transaction, for both account types, nothing to configure in PayPlanet's own back-office.
  2. Local payment methods available on the Payments (Provider account) flow (actual availability depends on what's enabled for your account):

    Country Currency Method Service code customer/fields forwarded
    Argentina ARS Bank transfer bank_transfer_ars_hpp customer.name/email/phone
    Argentina ARS Bank transfer (CBU) bank_transfer_cbu_ars_hpp customer.name/email/phone
    Argentina ARS Bank transfer (CVU) bank_transfer_cvu_ars_hpp customer.name/email/phone
    Colombia COP PSE pse_cop_hpp customer.name/phone/address.street
    Colombia COP Nequi nequi_cop_hpp customer.name/phone/address.country
    Colombia COP Bre-B breb_cop_hpp customer.name/email/phone
    Peru PEN Bank transfer bank_transfer_pen_hpp customer.name/email
    Chile CLP Bank transfer bank_transfer_clp_hpp customer.name/email
  3. Local payout methods available on the Payouts (Provider account) flow (actual availability depends on what's enabled for your account):

    Country Currency Method Service code fields.*
    - USD Card payment_card_usd card_number
    - KZT Card payment_card_kzt card_number
    Colombia COP Bre-B breb_cop document_type, document_number, account_number, bank_account_type
    Colombia COP Bank transfer bank_transfer_cop document_type, document_number, account_number, bank_code, bank_name, bank_account_type
    Peru PEN Bank transfer bank_transfer_pen document_type, document_number, account_number, bank_account_number, bank_code, bank_name, bank_account_type
    Argentina ARS Bank transfer bank_transfer_ars none beyond customer (no extra fields.*)

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify credentials for the selected environment and account type
  • Refund request fails on H2H Merchant account -> this connector doesn't support refunds through Corefy
  • Local payment/payout rejected for missing fields -> required fields.* vary by country/method - check the tables in Additional info
  • Currency or service is not supported -> confirm allowed currencies/features in your PayPlanet account and in Corefy
  • Not sure which account type to use? -> ask your Corefy account manager

Question

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