Skip to content

Logo

CitrinePay

We provide Expediency.Security.Reliability.Flexibility. CitrinePay is a payment gateway that provides local bank transfer and credit card solutions to all types of low and high risks merchants.

Website: citrinepay.co

Set up Account Provider account

Step 1: Create Provider account

To create an account send connection request at the citrinepay.co/contact-us or contact manager directly. Submit the required documents to verify your account and gain access.

Step 2: Get required credentials

Credentials that have to be issued:

  • citrinepay__merchant_id → MID
  • citrinepay__partner_control → Partner Control
  • citrinepay__currency → Currency
  • citrinepay__method → Method

Connect Provider Account

Step 1. Connect Provider account at the Corefy Dashboard

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

Connect

Enter credentials:

  • Merchant ID
  • Partner Control

Success

You have connected CitrinePay Provider account!

API examples:

Minimum data set to create a payment invoices for qr_payment_aggregated_php_hpp service

PAYMENT

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"qr_payment_aggregated_php_hpp",
      "commerce_account":"Hello World",
      "currency":"PHP",
      "amount":100,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"e13179f8-664e-4b54-bef9-41ba9baec8e1"
      }
    },
    "test_mode":false,
    "options":{
      "allow_partially":false,
      "bypass_hpp":false,
      "send_operation_context_on_return":false
    },
    "reference_id":"2ede44c0-419f-4c61-b400-8ab755bad9b2",
    "service_fields":[
    ]
  }
}
}

Maximum data set to create a payment invoices for qr_payment_aggregated_php_hpp service

this request will be successful only if the constants are filled
PAYMENT

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"qr_payment_aggregated_php_hpp",
      "commerce_account":"Hello World",
      "currency":"PHP",
      "amount":100,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"e13179f8-664e-4b54-bef9-41ba9baec8e1",
        "name":"John Doe",
        "email":"[email protected]",
        "phone":"+4459685949658",
        "address":{
          "full_address":"Sidney",
          "country":"AU",
          "city":"Sidney",
          "post_code":"777777"
        },
        "metadata":{
          "ip":"1.1.1.1"
        }
      },
      "test_mode":false,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "reference_id":"2ede44c0-419f-4c61-b400-8ab755bad9b2",
      "service_fields":[
      ]
    }
  }
}

Minimum data set to create a payout invoices for bank_transfer_php service

PAYOUT

POST /api/commerce/payout-invoices HTTP/1.0

{
  "data":{
    "type":"payout-invoice",
    "attributes":{
      "service":"bank_transfer_php",
      "commerce_account":"hello_world",
      "currency":"PHP",
      "amount":3000,
      "test_mode":false,
      "reference_id":"8dd30395-643d-4f3b-9a8d-9d0c14197a70",
      "fields":{
        "account_number":"109420113109",
        "bank_code":"UB",
        "bank_address":"Lower G\/F Uptown Place Mall, 9th Avenue, Bonifacio Global City, TAGUIG",
        "beneficiary_name":"Ralph Lester Salita",
        "beneficiary_phone":"12312312311",
        "beneficiary_email":"[email protected]"
      },
      "options":{
        "attempts_limit":0,
        "split_mode":false,
        "allow_partially":false,
        "auto_process":false
      }
    }
  }
}

Constants

С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:

  • EMAIL → customer [last_name]
  • PHONE → customer [phone]
  • FIRST_NAME → customer [first_name]
  • LAST_NAME → customer [last_name]
  • COUNTRY_CODE → customer [address] [country]
  • CITY → customer [address] [city]
  • ADDRESS → customer [address] [address]
  • POST_CODE → customer[address][post_code]
  • USER_IP → constant [ip]

Question

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