Qodex.ai
Qodex.ai
Introduction
Revio payment orchestration
Clients
Create clientList clientsInspect a clientDelete a clientReplace a clientUpdate a clientList purchases for a clientList client tokensInspect a client tokenDelete a client token
Purchases
Create a purchaseInspect a purchaseResend invoice emailCharge a purchaseRefund a purchaseCancel a purchaseDelete purchase tokenMark a purchase as paid
Payment links
Create payment link
Bill presentment
Step 1: Create clientStep 2: Create invoiceResend invoice
Once off payments-Multi method
Step 1: Create clientStep 2: Create purchase
Once off payments-Card
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional SAQ-A-EP)
Once off payments-Card holds
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional SAQ-A-EP)Step 2b: Inspect a purchase (optional)Step 3a: Capture a hold (optional)Step 3b: Release a hold (optional)
Once off payments-S2S Card (SAQ-D)
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: AuthorizationStep 2b: CaptureStep 4: Charge customer
Once off payments-Ozow (redirect)
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional)
Once off payments-Capitec Pay
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional)
Once off payments-Zapper (redirect)
Step 1: Create clientStep 2: Create purchase
Recurring payments-Card
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: Direct charge (optional SAQ-A-EP)Step 4: Charge customer
Recurring payments-Card on file
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: Direct charge (SAQ-A-EP)Step 4: Charge customer
Recurring payments-Debit order
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: Direct charge (optional)Step 4: Charge customer
Recurring payments-DebiCheck
Step 1: Create clientStep 5: Create upcoming purchase (recurring)Step 2a: Direct charge (optional)Step 4: Charge customer (first)Step 6: Charge customer (recurring)
Subscription billing-Subscription management
List billing templatesInspect a billing templateDelete a billing templateReplace a billing templateList clients for a billing templateInspect a subscriptionList a subscription feedUpdate a subscription
Subscription billing-Card
Step 1: Create clientStep 2: Create billing templateStep 3: Add subscriber & tokenise cardStep 3a: Direct charge (optional SAQ-A-EP)Adhoc - Replace billing templateAdhoc - Modify subscriptionAdhoc - Subscriber override
Subscription billing-Debit order
Step 1: Create clientStep 2: Create billing templateStep 3: Add subscriber & tokenise bank accountStep 3a: Direct charge bank accountAdhoc - Amend Billing templateAdhoc - Amend subscriber detailsAdhoc - Subscriber override
Subscription billing-DebiCheck
Step 1: Create clientStep 2: Create billing templateStep 3: Add subscriber & tokenise bank accountStep 3a: Direct charge bank accountAdhoc - Amend Billing templateAdhoc - Amend subscriber detailsAdhoc - Subscriber override
Refunds
Refund a purchase
Payouts-From account to card
Step 1: New payoutStep 2: Execute payoutStep 3: Get status
Introduction
Revio payment orchestration
Clients
Create clientList clientsInspect a clientDelete a clientReplace a clientUpdate a clientList purchases for a clientList client tokensInspect a client tokenDelete a client token
Purchases
Create a purchaseInspect a purchaseResend invoice emailCharge a purchaseRefund a purchaseCancel a purchaseDelete purchase tokenMark a purchase as paid
Payment links
Create payment link
Bill presentment
Step 1: Create clientStep 2: Create invoiceResend invoice
Once off payments-Multi method
Step 1: Create clientStep 2: Create purchase
Once off payments-Card
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional SAQ-A-EP)
Once off payments-Card holds
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional SAQ-A-EP)Step 2b: Inspect a purchase (optional)Step 3a: Capture a hold (optional)Step 3b: Release a hold (optional)
Once off payments-S2S Card (SAQ-D)
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: AuthorizationStep 2b: CaptureStep 4: Charge customer
Once off payments-Ozow (redirect)
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional)
Once off payments-Capitec Pay
Step 1: Create clientStep 2: Create purchaseStep 2a: Direct charge (optional)
Once off payments-Zapper (redirect)
Step 1: Create clientStep 2: Create purchase
Recurring payments-Card
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: Direct charge (optional SAQ-A-EP)Step 4: Charge customer
Recurring payments-Card on file
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: Direct charge (SAQ-A-EP)Step 4: Charge customer
Recurring payments-Debit order
Step 1: Create clientStep 3: Create upcoming purchaseStep 2a: Direct charge (optional)Step 4: Charge customer
Recurring payments-DebiCheck
Step 1: Create clientStep 5: Create upcoming purchase (recurring)Step 2a: Direct charge (optional)Step 4: Charge customer (first)Step 6: Charge customer (recurring)
Subscription billing-Subscription management
List billing templatesInspect a billing templateDelete a billing templateReplace a billing templateList clients for a billing templateInspect a subscriptionList a subscription feedUpdate a subscription
Subscription billing-Card
Step 1: Create clientStep 2: Create billing templateStep 3: Add subscriber & tokenise cardStep 3a: Direct charge (optional SAQ-A-EP)Adhoc - Replace billing templateAdhoc - Modify subscriptionAdhoc - Subscriber override
Subscription billing-Debit order
Step 1: Create clientStep 2: Create billing templateStep 3: Add subscriber & tokenise bank accountStep 3a: Direct charge bank accountAdhoc - Amend Billing templateAdhoc - Amend subscriber detailsAdhoc - Subscriber override
Subscription billing-DebiCheck
Step 1: Create clientStep 2: Create billing templateStep 3: Add subscriber & tokenise bank accountStep 3a: Direct charge bank accountAdhoc - Amend Billing templateAdhoc - Amend subscriber detailsAdhoc - Subscriber override
Refunds
Refund a purchase
Payouts-From account to card
Step 1: New payoutStep 2: Execute payoutStep 3: Get status
HomeRevio payment orchestrationSubscription billing-Subscription management

Subscription billing-Subscription management

Number of APIs: 8

  1. Delete a billing template DELETE https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/

  2. List billing templates GET https://gate.reviopay.com/api/v1/billing_templates/

  3. Inspect a billing template GET https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/

  4. Replace a billing template PUT https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/

  5. List clients for a billing template GET https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/clients/

  6. Inspect a subscription GET https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/clients/{{billing_template_client_id}}/

  7. List a subscription feed GET https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/clients/{{billing_template_client_id}}/feed/

  8. Update a subscription PATCH https://gate.reviopay.com/api/v1/billing_templates/{{billing_template_id}}/clients/{{billing_template_client_id}}/

Previous
Step 6: Charge customer (recurring)
Next
List billing templates