Creedo

Set up Account

Step 1: Create Provider account

To create an account, you need to contact the Creedo team to get access and complete verification.

Step 2: Get required credentials

Credentials that have to be issued:

MID
Secret Key

Connect Provider Account

Step 1. Connect Provider account at the Corefy Dashboard

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

Connect

Enter credentials:

mid → MID
secret_key → Secret Key

Success

You have connected Creedo Provider account!

API examples for payments:

Minimum data set to create a payment invoice for bkash_limited_bdt_hpp service

PAYMENT
POST /api/payment-invoices HTTP/1.0
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bkash_limited_bdt_hpp",
      "currency": "BDT",
      "amount": 200,
      "reference_id": "83020cb4-79a4-4745-8c4c-782ceeced0f3",
      "test_mode": false
    }
  }
}

Maximum data set to create a payment invoice for bkash_limited_bdt_hpp service

PAYMENT
POST /api/payment-invoices HTTP/1.0
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bkash_limited_bdt_hpp",
      "currency": "BDT",
      "amount": 200,
      "reference_id": "83020cb4-79a4-4745-8c4c-782ceeced0f3",
      "test_mode": false,
      "customer": {
        "reference_id": "qwerty_123",
        "name": "John Doe",
        "phone": "+32434324324",
        "email": "[email protected]",
        "metadata": {
          "ip": "0.0.0.0"
        }
      }
    }
  }
}

API examples for payouts:

Minimum data set to create a payout invoice for bkash_limited_bdt service

PAYOUT
POST /api/payout-invoices HTTP/1.0
{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "test_mode": false,
      "reference_id": "83020cb4-79a4-4745-8c4c-782ceeced0f3",
      "currency": "BDT",
      "amount": 400,
      "service": "bkash_limited_bdt",
      "fields": {
        "account_number": "111111111111"
      }
    }
  }
}

Maximum data set to create a payout invoice for bkash_limited_bdt service

PAYOUT
POST /api/payout-invoices HTTP/1.0
{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "test_mode": false,
      "reference_id": "83020cb4-79a4-4745-8c4c-782ceeced0f3",
      "currency": "BDT",
      "amount": 400,
      "service": "bkash_limited_bdt",
      "fields": {
        "account_number": "111111111111"
      },
      "customer": {
        "reference_id": "qwerty_123",
        "name": "John Doe",
        "phone": "+32434324324",
        "email": "[email protected]",
        "metadata": {
          "ip": "0.0.0.0"
        }
      }
    }
  }
}

Constants for payments

Сonstants

If some parameters are not sent in the transaction creation request, they will take the values from the set constants.

Here is a list of constants with their corresponding parameters:

customer_id → customer [reference_id]
customer_name → customer [name]
customer_phone_number → customer [phone]
customer_email → customer [email]
customer_ip → customer [metadata] [ip]

Constants for payouts

Сonstants

If some parameters are not sent in the transaction creation request, they will take the values from the set constants.

Here is a list of constants with their corresponding parameters:

customer_id → customer [reference_id]
customer_name → customer [name]
customer_phone_number → customer [phone]
customer_email → customer [email]
customer_ip → customer [metadata] [ip]

Question

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