Skip to content

Logo

TakapayJazzCash

Enable seamless digital transactions, anytime and anywhere

Supports in this guide: Payments, Payouts

Provider website: jazzcash.com.pk

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

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

Choose account type

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

  • If you do JazzCash payments -> choose Merchant account
  • If you do JazzCash payouts -> choose Provider account

TakapayJazzCash does not currently support payments through a Provider account, or payouts through a Merchant account. If you're not sure which one to use, confirm with your Corefy account manager.

Prerequisites: get from TakapayJazzCash

Send a connection request at jazzcash.com.pk/contact-us or contact your TakapayJazzCash account manager directly to get your account verified and receive the following credentials. Merchant account and Provider account are separate connections with independent credentials.

For Merchant account:

  • Merchant ID -> Corefy field merchant_id.
  • Password -> Corefy field password.
  • Secret key -> Corefy field secret_key.
  • API type -> Corefy field api_type -> v1 or v2; confirm with your account manager which version applies to your account.
  • Return URL (optional) -> Corefy field return_url.
  • API URL (optional) -> Corefy field api_url -> leave as default unless your account manager tells you otherwise.

For Provider account:

  • Token key -> Corefy field token_key.
  • Initial vector -> Corefy field initial_vector.
  • Secret key -> Corefy field secret_key.
  • API URL (optional) -> Corefy field api_url.

PKR only.

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

Connect Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant ID
  • Password
  • Secret key
  • API type -> v1 or v2
  • Return URL (optional)
  • API URL (optional)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected TakapayJazzCash Merchant account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice. Two services are available: jazzcash_pkr_transfer (direct transfer) and jazzcash_pkr_invoice (an invoice flow that asks the customer for their JazzCash mobile number before confirming the payment, handled transparently behind this same request).

Payment - MIN (direct transfer)

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "1748441082",
      "provider_reference_id": "order-1748441082",
      "service": "jazzcash_pkr_transfer",
      "currency": "PKR",
      "amount": 100,
      "service_fields": {
        "phone_number": "03123456789"
      }
    }
  }
}

Important

  • provider_reference_id is required for Payments on this connector.
  • service_fields.phone_number (the customer's JazzCash mobile wallet number) is required.
  • service_fields.cnic_number (the customer's national ID number) is required in addition to phone_number, but only when API type is v2.

Payment - MAX

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "1748441083",
      "provider_reference_id": "order-1748441083",
      "service": "jazzcash_pkr_transfer",
      "currency": "PKR",
      "amount": 100,
      "service_fields": {
        "phone_number": "03123456789",
        "cnic_number": "123456"
      }
    }
  }
}

Note

For jazzcash_pkr_invoice, omit service_fields from the request - Corefy returns an invoice asking the customer for their phone number directly, then confirms the payment once it's provided.

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 the provider 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 -> provider may reject the request or apply its defaults (depends on provider)

Currently available constants (constant -> Corefy API field)

  • LANGUAGE -> interface language sent to TakapayJazzCash (2-letter code); defaults to EN if not set. Available only for the jazzcash_pkr_transfer service.

Refunds

TakapayJazzCash does not support refunds.

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

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Token key
  • Initial vector
  • Secret key
  • API URL (optional)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected TakapayJazzCash Provider account!

First request to Corefy API (MIN)

What it does: creates a payout-invoice and sends funds to a JazzCash mobile wallet.

Payout - MIN

POST /api/payout-invoices 

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "1748441082",
      "service": "jazzcash_pkr",
      "currency": "PKR",
      "amount": 10,
      "fields": {
        "account_number": "03001234567"
      }
    }
  }
}

Important

fields.account_number (the recipient's JazzCash mobile wallet number) is required.

Payout - MAX

Same as MIN - no additional fields are used beyond the RECEIVER_CNIC Constant described below.

Constants (fallback fields)

Currently available constants (constant -> TakapayJazzCash field)

  • RECEIVER_CNIC -> the recipient's national ID number -> if not set, a fixed placeholder (0000000000000) is sent to TakapayJazzCash instead.

TakapayJazzCash does not support refunds for payouts.

Additional info

  1. Active reconciliation is available - both Payments and Payouts support an active status request in addition to the asynchronous callback.
  2. No recurring - this connector does not support saving/charging a token through Corefy.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify the credentials for the selected account type and environment (test_mode) - Merchant account and Provider account use entirely different credential sets
  • Payment rejected for missing CNIC -> service_fields.cnic_number is required in addition to phone_number when API type is v2
  • Payout sent with an unexpected CNIC -> set the RECEIVER_CNIC Constant; otherwise a fixed placeholder value is sent
  • Currency or service is not supported -> confirm allowed currencies/features in your TakapayJazzCash account and in Corefy - only PKR is available
  • Not sure which account type to use? -> Merchant account is for Payments; Provider account is for Payouts

Question

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