Alliancepay
A new Era of Payment Solution
Supports in this guide: Payments | Payouts
Provider website: alliancepay.io
Connect in Corefy Dashboard: open AlliancePay in the provider directory and press Connect at Alliancepay Provider Overview page
What you need to process transactions (brief summary)
Credentials (from AlliancePay):
- Merchant ID
- Service code
- Payment key (file upload in Corefy)
- Private key (file upload in Corefy)
Steps: choose connection type → connect in Dashboard → send an API request
Choose connection type
AlliancePay can be connected in different ways (depending on your needs):
- If you do payouts → choose Provider account
- If you do card payments → choose H2H Merchant account
If you’re not sure which one to use, confirm with your Corefy account manager.
Prerequisites: get from AlliancePay
Get the following values for your AlliancePay project/account:
- Merchant ID → Corefy field
merchant_id→ example:mid_123456789→ where to find: AlliancePay backoffice / issued by AlliancePay manager - Service code → Corefy field
service_code→ example:svc_001→ where to find: AlliancePay backoffice / issued by AlliancePay manager - Payment key → Corefy field
payment_key→ format: upload a text file containing the key → where to find: AlliancePay backoffice / issued by AlliancePay manager - Private key → Corefy field
private_key→ format: upload a text file containing the key → where to find: AlliancePay backoffice / issued by AlliancePay manager
Payments processing (connect Merchant account, create payment-invoice)
Connect in Corefy Dashboard (H2H Merchant account)
Step 1 — Open connection form
Open AlliancePay in the provider directory and press Connect at Alliancepay Provider Overview page in the New connection section. Choose H2H Merchant account.
Step 2 — Fill in fields and select settings
- Merchant ID
- Payment Key (upload text file)
- Private Key (upload text file)
- Service Code
- API type → select the API type for your AlliancePay account
Additionally, choose Currency and Features according to what is enabled for your AlliancePay account.
Success
You have connected AlliancePay H2H Merchant account!
First request to Corefy API (MIN)
What it does: creates a payment-invoice.
Payment — MIN
POST /api/payment-invoices
{
"data": {
"type": "payment-invoice",
"attributes": {
"service": "payment_card_uah_hpp",
"currency": "UAH",
"amount": 10
}
}
}
Payment — MAX
POST /api/payment-invoices
{
"data": {
"type": "payment-invoice",
"attributes": {
"service": "payment_card_uah_hpp",
"currency": "UAH",
"amount": 10.04,
"customer": {
"reference_id": "cus_123",
"email": "sss@gmail.com"
}
}
}
}
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
Options
Note
Options are configured on the Corefy side and affect how Corefy builds provider requests or processes responses.
Currently available options:
api_type— selects the API type for your AlliancePay account.
api_type
What it does: selects which AlliancePay API mode Corefy will use for requests.
When to use: use it when your AlliancePay account supports multiple API modes, or when your account manager asked you to use a specific API type.
Default: "Purchase"
Allowed values: select any from the dropdown in Corefy Dashboard
Tip
If you are not sure which value to select, confirm it with your Corefy account manager.
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.
If a field is missing in the API request, Corefy can take the value from the configured Constants.
Question
When do I need constants?
Use constants when you cannot provide certain customer/merchant fields dynamically in your API requests.
Priority (predictable rule):
- If a value is present in the request → Corefy uses the request value
- Else if the constant is set and value isn't present in the request → Corefy uses the constant
- Else → provider may reject the request or apply its defaults (depends on provider)
Currently available constants (constant → Corefy API field)
STREET→customer.address.streetCOUNTRY→customer.address.countryCITY→customer.address.cityNAME→customer.name
Payouts processing (connect Provider account, create payout-invoice)
Connect in Corefy Dashboard (Provider account)
Step 1 — Open connection form
Open AlliancePay in the provider directory and press Connect at Alliancepay Provider Overview page in the New connection section. Choose Provider account.
Step 2 — Fill in fields (provider → Corefy)
- Merchant ID →
merchant_id - Service code →
service_code - Payment key →
payment_key(upload a text file) - Private key →
private_key(upload a text file)
Success
You have connected AlliancePay Provider account!
First request to Corefy API (MIN)
What it does: creates a payout-invoice.
Payout — MIN
POST /api/payout-invoices
{
"data": {
"type": "payout-invoice",
"attributes": {
"service": "payment_card_uah",
"currency": "UAH",
"amount": 10,
"fields": {
"card_number": "411111******1111"
}
}
}
}
Payout — MAX
POST /api/payout-invoices
{
"data": {
"type": "payout-invoice",
"attributes": {
"service": "payment_card_uah",
"currency": "UAH",
"amount": 10,
"customer": {
"reference_id": "33cc9165-6ab2-4cee-8d9a-10f05cddbb5a",
"name": "John Doe",
"address": {
"country": "UA",
"city": "Lviv",
"street": "Main street"
}
},
"fields": {
"card_number": "411111******1111"
}
}
}
}
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.
If a field is missing in the API request, Corefy can take the value from the configured Constants.
Question
When do I need constants?
Use constants when you cannot provide certain customer/merchant fields dynamically in your API requests.
Priority (predictable rule):
- If a value is present in the request → Corefy uses the request value
- Else if the constant is set → Corefy uses the constant
- Else → provider may reject the request or apply its defaults (depends on provider)
Currently available constants (constant → Corefy API field)
STREET→customer.address.streetCOUNTRY→customer.address.countryCITY→customer.address.cityNAME→customer.name
Additional info
- For callbacks processing you need set up url in the AlliancePay backoffice.
- For H2H Payments endpoint is
/alliancepay/callback. - For Payouts endpoint is
/alliancepay/payout-callback.
- For H2H Payments endpoint is
-
AlliancePay supports Apple Pay and Google Pay with decryption on AlliancePay side.
For more information, visit:
FAQ / Troubleshooting
- Invalid credentials / auth error → verify you used the correct keys for the chosen environment (sandbox vs production)
- Currency not supported → confirm allowed currencies/features in your AlliancePay account and in Corefy
- Missing customer data fields → set constants (see “Constants”) or provide fields in the API request
- Not sure which connection type to use? → ask your Corefy account manager
Question
Still looking for help connecting your AlliancePay account? Please contact our support team!