Klyme¶
Real-time Payments with Klyme: Your Payments Taking Center Stage.
Website: klyme.io
Set up Account Provider account¶
Step 1: Create Provider account¶
To create an account send connection request at the klyme.io/contact 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:
- klyme__merchant_uuid → Merchant UUID
- klyme__api_key → Api key
- klyme__secret_key → Secret key
- klyme__test_mode → Test mode
Connect Provider Account¶
Step 1. Connect Provider account at the Corefy Dashboard¶
Press Connect at Klyme Provider Overview page in 'New connection' section and choose Provider account option to open Connection form.
Enter credentials:
- Merchant UUID
- Api key
- Secret key
- Test mode → true/false
Success
You have connected Klyme Provider account!
API examples:¶
Minimum data set to create a payment invoices for klyme_gbp_invoice service¶
PAYMENT
POST /api/commerce/payment-invoices HTTP/1.0
{
"data":{
"type":"payment-invoice",
"attributes":{
"service":"klyme_gbp_invoice",
"commerce_account":"hello_world",
"currency":"GBP",
"amount":1.32,
"reference_id":"7960a62c-3e23-4266-ae77-f767d18e0505",
"flow":"charge",
"gateway_options":{
"cardgate":{
"tokenize":""
}
},
"callback_url":"http:\/\/9649-3-65-180-235.ngrok-free.app",
"test_mode":true,
"options":{
"allow_partially":false,
"bypass_hpp":false,
"send_operation_context_on_return":false
},
"service_fields":[
]
}
}
}
Maximum data set to create a payment invoices for klyme_gbp_invoice service¶
PAYMENT
POST /api/commerce/payment-invoices HTTP/1.0
{
"data":{
"type":"payment-invoice",
"attributes":{
"service":"klyme_gbp_invoice",
"commerce_account":"hello_world",
"currency":"GBP",
"amount":1.57,
"reference_id":"510a01f5-97db-45ba-af93-6399228afed1",
"flow":"charge",
"gateway_options":{
"cardgate":{
"tokenize":""
}
},
"customer":{
"reference_id":"max_customer",
"name":"John Doe",
"email":"[email protected]",
"phone":"50678832789",
"address":{
"full_address":"London",
"country":"GB",
"city":"London",
"post_code":"7363218"
}
},
"callback_url":"http:\/\/9649-3-65-180-235.ngrok-free.app",
"test_mode":true,
"options":{
"allow_partially":false,
"bypass_hpp":false,
"send_operation_context_on_return":false
},
"service_fields":[
]
}
}
}
Constants¶
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:
- PHONE → customer [phone]
- COUNTRY → customer [address] [country]
- EMAIL → customer [email]
- FIRST_NAME → customer [first_name]
- LAST_NAME → customer [last_name]
- CITY → customer [address] [city]
- POST_CODE → customer [address] [post_code]
- ADDRESS → customer [address] [address]
Question
"Still looking for help connecting your Klyme account?" Please contact our support team!