{"items":[{"type":"group","label":"Overview","items":[{"type":"link","fsPath":"api-documentation/index.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/api-documentation","routeSlug":"/api-documentation"},{"type":"link","fsPath":"api-documentation/getting_started.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/api-documentation/getting_started","routeSlug":"/api-documentation/getting_started"},{"type":"link","fsPath":"api-documentation/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/api-documentation/authentication","routeSlug":"/api-documentation/authentication"},{"type":"link","fsPath":"api-documentation/pagination.md","metadata":{"type":"markdown"},"label":"Pagination","link":"/api-documentation/pagination","routeSlug":"/api-documentation/pagination"},{"type":"link","fsPath":"api-documentation/rate_limit.md","metadata":{"type":"markdown"},"label":"Rate Limits","link":"/api-documentation/rate_limit","routeSlug":"/api-documentation/rate_limit"},{"type":"link","fsPath":"api-documentation/errors.md","metadata":{"type":"markdown"},"label":"Errors","link":"/api-documentation/errors","routeSlug":"/api-documentation/errors"},{"type":"link","fsPath":"api-documentation/versioning.md","metadata":{"type":"markdown"},"label":"Versioning","link":"/api-documentation/versioning","routeSlug":"/api-documentation/versioning"},{"type":"link","fsPath":"api-documentation/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/api-documentation/webhooks","items":[{"type":"link","fsPath":"api-documentation/webhooks/glomo-webhooks.md","metadata":{"type":"markdown"},"label":"Glomo Webhooks","link":"/api-documentation/webhooks/glomo-webhooks","routeSlug":"/api-documentation/webhooks/glomo-webhooks"}],"routeSlug":"/api-documentation/webhooks"},{"type":"link","fsPath":"api-documentation/security.md","metadata":{"type":"markdown"},"label":"Security","link":"/api-documentation/security","routeSlug":"/api-documentation/security"},{"type":"link","fsPath":"api-documentation/validations.md","metadata":{"type":"markdown"},"label":"API Validations","link":"/api-documentation/validations","routeSlug":"/api-documentation/validations"}],"expanded":"true"},{"type":"group","label":"API Reference","items":[{"type":"link","label":"API specification for Glomo","link":"/api-documentation/apis/openapi","routeSlug":"/api-documentation/apis/openapi"},{"type":"separator","label":"Authentication"},{"type":"group","label":"API Key","link":"/api-documentation/apis/openapi/api_key","routeSlug":"/api-documentation/apis/openapi/api_key","items":[{"label":"Rotate API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/api_key/rotateapikey","routeSlug":"/api-documentation/apis/openapi/api_key/rotateapikey","metadata":{"seo":{"title":"Rotate API key","description":"Rotates the secret API key for your account, generating a new key immediately. The previous key remains valid until expire_after_in_seconds has elapsed, giving you time to update your integrations. Once the expiry period passes, the old key is revoked and any requests using it will return 401 Unauthorized."}},"httpPath":"/api-keys/rotate"}]},{"type":"separator","label":"Multi Currency Account"},{"type":"group","label":"Balance","link":"/api-documentation/apis/openapi/balance","routeSlug":"/api-documentation/apis/openapi/balance","items":[{"label":"Retrieve balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/balance/getbalance","routeSlug":"/api-documentation/apis/openapi/balance/getbalance","metadata":{"seo":{"title":"Retrieve balances","description":"Retrieves available balances for all currencies."}},"httpPath":"/balances"},{"type":"link","label":"AllBalances","link":"/api-documentation/apis/openapi/balance/allbalances","routeSlug":"/api-documentation/apis/openapi/balance/allbalances","httpVerb":"schema"},{"type":"link","label":"Balance","link":"/api-documentation/apis/openapi/balance/balance","routeSlug":"/api-documentation/apis/openapi/balance/balance","httpVerb":"schema"}]},{"type":"group","label":"Balance Conversions","link":"/api-documentation/apis/openapi/balance_conversions","routeSlug":"/api-documentation/apis/openapi/balance_conversions","items":[{"label":"Convert balances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/balance_conversions/createbalanceconversion","routeSlug":"/api-documentation/apis/openapi/balance_conversions/createbalanceconversion","metadata":{"seo":{"title":"Convert balances","description":"Converts balance from one currency to another. In the API you can either send target_amount or source_amount and the API will calculate the other amount for you."}},"httpPath":"/balance_conversions"},{"label":"List all Balance Conversions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/balance_conversions/getbalanceconversions","routeSlug":"/api-documentation/apis/openapi/balance_conversions/getbalanceconversions","metadata":{"seo":{"title":"List all Balance Conversions","description":"Returns a list of your balance conversions. The balance conversions are returned sorted by creation date, with the most recent beneficiary appearing first."}},"httpPath":"/balance_conversions"},{"type":"link","label":"BalanceConversion","link":"/api-documentation/apis/openapi/balance_conversions/balanceconversion","routeSlug":"/api-documentation/apis/openapi/balance_conversions/balanceconversion","httpVerb":"schema"}]},{"type":"group","label":"FX","link":"/api-documentation/apis/openapi/fx_rate","routeSlug":"/api-documentation/apis/openapi/fx_rate","items":[{"label":"Get Mid-Market Rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/fx_rate/getmidmarketrate","routeSlug":"/api-documentation/apis/openapi/fx_rate/getmidmarketrate","metadata":{"seo":{"title":"Get Mid-Market Rate","description":"Returns the current mid-market exchange rate for a given currency pair.This is the base rate before any FX fees — FX fees will be charged on top of this rate."}},"httpPath":"/fx-rate"}]},{"type":"separator","label":"Payin"},{"type":"group","label":"Payment Link","link":"/api-documentation/apis/openapi/payment_link","routeSlug":"/api-documentation/apis/openapi/payment_link","items":[{"label":"Create a new Payment Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/createpayin","routeSlug":"/api-documentation/apis/openapi/payment_link/createpayin","metadata":{"seo":{"title":"Create a new Payment Link","description":"Create a shareable URL for a hosted payment page in one of two ways:"}},"httpPath":"/payin"},{"label":"List all payment links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/getpayins","routeSlug":"/api-documentation/apis/openapi/payment_link/getpayins","metadata":{"seo":{"title":"List all payment links","description":"Returns a list of your payment links. The payment links are returned sorted by creation date, with the most recent payment link appearing first."}},"httpPath":"/payin"},{"label":"Retrieve a payment link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/getpayinbyid","routeSlug":"/api-documentation/apis/openapi/payment_link/getpayinbyid","metadata":{"seo":{"title":"Retrieve a payment link","description":"Retrieve details of a payment link."}},"httpPath":"/payin/{id}"},{"label":"Update an existing payment link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/updatepayin","routeSlug":"/api-documentation/apis/openapi/payment_link/updatepayin","metadata":{"seo":{"title":"Update an existing payment link","description":"Update an existing payment link"}},"httpPath":"/payin/{id}"},{"label":"Cancel a payment link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/cancelpayin","routeSlug":"/api-documentation/apis/openapi/payment_link/cancelpayin","metadata":{"seo":{"title":"Cancel a payment link","description":"Invalidate payment link and prevent further transactions"}},"httpPath":"/payin/{id}/cancel"},{"label":"Update RFI documents for a payment link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/updatepayinrfi","routeSlug":"/api-documentation/apis/openapi/payment_link/updatepayinrfi","metadata":{"seo":{"title":"Update RFI documents for a payment link","description":"Updates the RFI (Request for Information) document status for a payment link. This endpoint is used to submit required documents when a payment link is in 'action_required' status due to sanction screening."}},"httpPath":"/payin/{id}/update_rfi"},{"label":"Mock review a payment link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_link/mockreviewpaymentlink","routeSlug":"/api-documentation/apis/openapi/payment_link/mockreviewpaymentlink","metadata":{"seo":{"title":"Mock review a payment link","description":"Mark an under_review payment link reviewed"}},"httpPath":"/payin/{id}/mock_mark_reviewed"},{"type":"link","label":"PaymentLink","link":"/api-documentation/apis/openapi/payment_link/paymentlink","routeSlug":"/api-documentation/apis/openapi/payment_link/paymentlink","httpVerb":"schema"}]},{"type":"group","label":"Orders","link":"/api-documentation/apis/openapi/orders","routeSlug":"/api-documentation/apis/openapi/orders","items":[{"label":"Create a new order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/orders/createorder","routeSlug":"/api-documentation/apis/openapi/orders/createorder","metadata":{"seo":{"title":"Create a new order","description":"Create an order for checkout in one of two ways:"}},"httpPath":"/orders"},{"label":"List all orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/orders/getorders","routeSlug":"/api-documentation/apis/openapi/orders/getorders","metadata":{"seo":{"title":"List all orders","description":"Returns a list of your orders. The orders are returned sorted by creation date, with the most recent order appearing first."}},"httpPath":"/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/orders/getorderbyid","routeSlug":"/api-documentation/apis/openapi/orders/getorderbyid","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieve details of an order."}},"httpPath":"/orders/{id}"},{"label":"Update RFI documents for an order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/orders/updateorderrfi","routeSlug":"/api-documentation/apis/openapi/orders/updateorderrfi","metadata":{"seo":{"title":"Update RFI documents for an order","description":"Updates the RFI (Request for Information) document status for an order. This endpoint is used to submit required documents when an order is in 'action_required' status due to sanction screening."}},"httpPath":"/orders/{id}/update-rfi"},{"type":"link","label":"Orders","link":"/api-documentation/apis/openapi/orders/orders","routeSlug":"/api-documentation/apis/openapi/orders/orders","httpVerb":"schema"}]},{"type":"group","label":"Customer","link":"/api-documentation/apis/openapi/customer","routeSlug":"/api-documentation/apis/openapi/customer","items":[{"label":"Create a new customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/customer/createcustomer","routeSlug":"/api-documentation/apis/openapi/customer/createcustomer","metadata":{"seo":{"title":"Create a new customer","description":"Creates a customer with basic information such as name, contact information, and address. To check complete list of API validations, click here."}},"httpPath":"/customer"},{"label":"List all customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/customer/getcustomers","routeSlug":"/api-documentation/apis/openapi/customer/getcustomers","metadata":{"seo":{"title":"List all customers","description":"Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first."}},"httpPath":"/customer"},{"label":"Retrieve a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/customer/getcustomerbyid","routeSlug":"/api-documentation/apis/openapi/customer/getcustomerbyid","metadata":{"seo":{"title":"Retrieve a customer","description":"Retrieves details of a Customer."}},"httpPath":"/customer/{id}"},{"label":"Update a customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/customer/updatecustomer","routeSlug":"/api-documentation/apis/openapi/customer/updatecustomer","metadata":{"seo":{"title":"Update a customer","description":"Updates the contact details of an existing customer. Only the customer's email and phone can be updated. This is a partial update — send only the fields you want to change; any field you omit is left untouched. You must supply at least one of email or phone, and a supplied field cannot be sent as blank or null. The phone number is validated against the customer's stored country. To check the complete list of API validations, click here."}},"httpPath":"/customer/{id}"},{"label":"Register a customer's bank account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/customer/createcustomerbankaccount","routeSlug":"/api-documentation/apis/openapi/customer/createcustomerbankaccount","metadata":{"seo":{"title":"Register a customer's bank account","description":"Registers the bank account a customer sends money from."}},"httpPath":"/customer/{id}/bank-accounts"},{"label":"List a customer's bank accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/customer/getcustomerbankaccounts","routeSlug":"/api-documentation/apis/openapi/customer/getcustomerbankaccounts","metadata":{"seo":{"title":"List a customer's bank accounts","description":"Returns the bank accounts registered against a customer."}},"httpPath":"/customer/{id}/bank-accounts"},{"type":"link","label":"Customer","link":"/api-documentation/apis/openapi/customer/customer","routeSlug":"/api-documentation/apis/openapi/customer/customer","httpVerb":"schema"}]},{"type":"group","label":"Payment","link":"/api-documentation/apis/openapi/payment","routeSlug":"/api-documentation/apis/openapi/payment","items":[{"label":"Create a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment/createpayment","routeSlug":"/api-documentation/apis/openapi/payment/createpayment","metadata":{"seo":{"title":"Create a payment","description":"Creates a payment for an order or subscription. For initial payments, card details and a callback URL are required. For subsequent payments on as_presented subscriptions, the card from the last successful payment is reused, and request_id, amount, and currency are required instead."}},"httpPath":"/payment"},{"label":"List all payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment/getpayments","routeSlug":"/api-documentation/apis/openapi/payment/getpayments","metadata":{"seo":{"title":"List all payments","description":"List all payments"}},"httpPath":"/payment"},{"label":"Create a mock payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment/createmockpayment","routeSlug":"/api-documentation/apis/openapi/payment/createmockpayment","metadata":{"seo":{"title":"Create a mock payment","description":"This API is only available in sandbox mode. Creates a mock payment of specified amount for any given Payment link."}},"httpPath":"/payment/mock"},{"label":"Retrieve a payment\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment/getpaymentbyid","routeSlug":"/api-documentation/apis/openapi/payment/getpaymentbyid","metadata":{"seo":{"title":"Retrieve a payment\n","description":"Retrieve a payment\n"}},"httpPath":"/payment/{id}"},{"label":"Mock funds available","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment/mockupdatepaymentfundsavailable","routeSlug":"/api-documentation/apis/openapi/payment/mockupdatepaymentfundsavailable","metadata":{"seo":{"title":"Mock funds available","description":"This API is only available in sandbox mode. Updates the funds_available status of a payment to simulate  the availability of funds for testing purposes."}},"httpPath":"/payment/{id}/mock-funds-available"},{"type":"link","label":"Payment","link":"/api-documentation/apis/openapi/payment/payment","routeSlug":"/api-documentation/apis/openapi/payment/payment","httpVerb":"schema"}]},{"type":"group","label":"Refund","link":"/api-documentation/apis/openapi/refund","routeSlug":"/api-documentation/apis/openapi/refund","items":[{"label":"Create refund for a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/refund/createrefund","routeSlug":"/api-documentation/apis/openapi/refund/createrefund","metadata":{"seo":{"title":"Create refund for a payment","description":"Creates refund for a payment entity if the payment is in success state and no other refund exists."}},"httpPath":"/refunds"},{"label":"List all refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/refund/getrefunds","routeSlug":"/api-documentation/apis/openapi/refund/getrefunds","metadata":{"seo":{"title":"List all refunds","description":"Returns a list of refunds in response. The refunds are returned sorted by creation date, with the most recent refund appearing first."}},"httpPath":"/refunds"},{"label":"Retrieve a refund\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/refund/getrefundbyid","routeSlug":"/api-documentation/apis/openapi/refund/getrefundbyid","metadata":{"seo":{"title":"Retrieve a refund\n","description":"Retrieve a refund\n"}},"httpPath":"/refunds/{id}"},{"label":"Mock update a refund","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/refund/mockupdaterefund","routeSlug":"/api-documentation/apis/openapi/refund/mockupdaterefund","metadata":{"seo":{"title":"Mock update a refund","description":"Mark an in_progress refund as successful"}},"httpPath":"/refunds/{id}/mock_update_status"},{"type":"link","label":"Refund","link":"/api-documentation/apis/openapi/refund/refund","routeSlug":"/api-documentation/apis/openapi/refund/refund","httpVerb":"schema"}]},{"type":"group","label":"Price","link":"/api-documentation/apis/openapi/price","routeSlug":"/api-documentation/apis/openapi/price","items":[{"label":"Create a new price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/price/createprice","routeSlug":"/api-documentation/apis/openapi/price/createprice","metadata":{"seo":{"title":"Create a new price","description":"Create a new price"}},"httpPath":"/prices"},{"label":"List all prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/price/getprices","routeSlug":"/api-documentation/apis/openapi/price/getprices","metadata":{"seo":{"title":"List all prices","description":"List all prices"}},"httpPath":"/prices"},{"label":"Retrieve a price\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/price/getpricebyid","routeSlug":"/api-documentation/apis/openapi/price/getpricebyid","metadata":{"seo":{"title":"Retrieve a price\n","description":"Retrieve a price\n"}},"httpPath":"/prices/{id}"},{"type":"link","label":"Price","link":"/api-documentation/apis/openapi/price/price","routeSlug":"/api-documentation/apis/openapi/price/price","httpVerb":"schema"}]},{"type":"group","label":"Dynamic Fee Split","link":"/api-documentation/apis/openapi/pricing_split","routeSlug":"/api-documentation/apis/openapi/pricing_split","items":[{"label":"List dynamic pricing rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/pricing_split/getdynamicprices","routeSlug":"/api-documentation/apis/openapi/pricing_split/getdynamicprices","metadata":{"seo":{"title":"List dynamic pricing rules","description":"Returns the payin pricing rules configured for your business whose fee bearer is dynamic. These are the rules you may declare a share of, with Create a pricing split."}},"httpPath":"/prices/dynamic"},{"label":"Create a pricing split","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/pricing_split/createpricingsplit","routeSlug":"/api-documentation/apis/openapi/pricing_split/createpricingsplit","metadata":{"seo":{"title":"Create a pricing split","description":"Declare your share of a dynamic pricing rule's fee. The customer bears the remainder. List the rules you may declare against with List dynamic pricing rules."}},"httpPath":"/prices/dynamic-splits"},{"label":"List pricing splits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/pricing_split/getpricingsplits","routeSlug":"/api-documentation/apis/openapi/pricing_split/getpricingsplits","metadata":{"seo":{"title":"List pricing splits","description":"Returns the pricing splits your business has declared, sorted by creation date with the most recent split first. Pass price_id to return only the splits declared against one dynamic pricing rule."}},"httpPath":"/prices/dynamic-splits"},{"type":"link","label":"DynamicPrice","link":"/api-documentation/apis/openapi/pricing_split/dynamicprice","routeSlug":"/api-documentation/apis/openapi/pricing_split/dynamicprice","httpVerb":"schema"},{"type":"link","label":"PricingSplit","link":"/api-documentation/apis/openapi/pricing_split/pricingsplit","routeSlug":"/api-documentation/apis/openapi/pricing_split/pricingsplit","httpVerb":"schema"}]},{"type":"group","label":"Payment Session","link":"/api-documentation/apis/openapi/payment_session","routeSlug":"/api-documentation/apis/openapi/payment_session","items":[{"label":"Create a payment session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payment_session/createpaymentsession","routeSlug":"/api-documentation/apis/openapi/payment_session/createpaymentsession","metadata":{"seo":{"title":"Create a payment session","description":"Creates a payment session — a configurable workflow that wraps a payment journey with pre-steps and/or post-steps such as identity verification, compliance checks, or data collection. The exact step sequence is determined by the session_type configured for your business."}},"httpPath":"/payment-sessions"}]},{"type":"separator","label":"Subscription"},{"type":"group","label":"Subscription","link":"/api-documentation/apis/openapi/subscription","routeSlug":"/api-documentation/apis/openapi/subscription","items":[{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/getsubscriptions","routeSlug":"/api-documentation/apis/openapi/subscription/getsubscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Returns a list of subscriptions matching some criteria. The subscriptions are returned sorted by creation date, with the most recent subscriptions appearing first."}},"httpPath":"/subscriptions"},{"label":"Create a new subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/createsubscription","routeSlug":"/api-documentation/apis/openapi/subscription/createsubscription","metadata":{"seo":{"title":"Create a new subscription","description":"Creates a new subscription for a customer with specified billing plan and schedule. The subscription will be created in 'created' status and will be activated when the customer completes the first payment."}},"httpPath":"/subscriptions"},{"label":"Retrieve a subscription by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/getsubscriptionbyid","routeSlug":"/api-documentation/apis/openapi/subscription/getsubscriptionbyid","metadata":{"seo":{"title":"Retrieve a subscription by ID","description":"Retrieves the details of a specific subscription by its unique identifier."}},"httpPath":"/subscriptions/{id}"},{"label":"Pause a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/pausesubscription","routeSlug":"/api-documentation/apis/openapi/subscription/pausesubscription","metadata":{"seo":{"title":"Pause a subscription","description":"Pauses an active subscription. While paused, the subscription will not process any payments. A paused subscription can be resumed later using the resume endpoint."}},"httpPath":"/subscriptions/{id}/pause"},{"label":"Resume a paused subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/resumesubscription","routeSlug":"/api-documentation/apis/openapi/subscription/resumesubscription","metadata":{"seo":{"title":"Resume a paused subscription","description":"Resumes a paused subscription. Once resumed, the subscription will continue processing payments according to its original schedule. Only subscriptions in 'paused' status can be resumed."}},"httpPath":"/subscriptions/{id}/resume"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/cancelsubscription","routeSlug":"/api-documentation/apis/openapi/subscription/cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancels a subscription. Once cancelled, the subscription will stop processing future payments. This action cannot be undone, but you can create a new subscription if needed."}},"httpPath":"/subscriptions/{id}/cancel"},{"label":"Update next payment date","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/subscription/updatenextpaymentdate","routeSlug":"/api-documentation/apis/openapi/subscription/updatenextpaymentdate","metadata":{"seo":{"title":"Update next payment date","description":"Updates the next payment date of a subscription."}},"httpPath":"/subscriptions/{id}/next-payment-date"},{"type":"link","label":"CreateSubscriptionResponse","link":"/api-documentation/apis/openapi/subscription/createsubscriptionresponse","routeSlug":"/api-documentation/apis/openapi/subscription/createsubscriptionresponse","httpVerb":"schema"},{"type":"link","label":"Subscription","link":"/api-documentation/apis/openapi/subscription/subscription","routeSlug":"/api-documentation/apis/openapi/subscription/subscription","httpVerb":"schema"}]},{"type":"separator","label":"Quote"},{"type":"group","label":"Quote","link":"/api-documentation/apis/openapi/quote","routeSlug":"/api-documentation/apis/openapi/quote","items":[{"label":"Create quotes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/quote/createquote","routeSlug":"/api-documentation/apis/openapi/quote/createquote","metadata":{"seo":{"title":"Create quotes","description":"Create one or more pricing quotes for a payout or payin. Each quote locks an exchange rate and fee breakdown for fixed period.Provide exactly one of source_amount or destination_amount."}},"httpPath":"/quotes"}]},{"type":"separator","label":"Payout"},{"type":"group","label":"Payout","link":"/api-documentation/apis/openapi/payout","routeSlug":"/api-documentation/apis/openapi/payout","items":[{"label":"Create a new payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payout/createpayout","routeSlug":"/api-documentation/apis/openapi/payout/createpayout","metadata":{"seo":{"title":"Create a new payout","description":"Create a payout in one of two ways:"}},"httpPath":"/payouts"},{"label":"List all payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payout/getpayouts","routeSlug":"/api-documentation/apis/openapi/payout/getpayouts","metadata":{"seo":{"title":"List all payouts","description":"List all payouts"}},"httpPath":"/payouts"},{"label":"Retrieve a payout\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payout/getpayoutbyid","routeSlug":"/api-documentation/apis/openapi/payout/getpayoutbyid","metadata":{"seo":{"title":"Retrieve a payout\n","description":"Retrieve a payout\n"}},"httpPath":"/payouts/{id}"},{"label":"Cancel a payout","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payout/cancelpayout","routeSlug":"/api-documentation/apis/openapi/payout/cancelpayout","metadata":{"seo":{"title":"Cancel a payout","description":"Cancel a payout"}},"httpPath":"/payouts/{id}/cancel"},{"label":"Update RFI for Payout","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payout/updaterfipayout","routeSlug":"/api-documentation/apis/openapi/payout/updaterfipayout","metadata":{"seo":{"title":"Update RFI for Payout","description":"Update RFI for Payout"}},"httpPath":"/payouts/{id}/update_rfi"},{"label":"Mock update a payout status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/payout/mockupdatepayoutstatus","routeSlug":"/api-documentation/apis/openapi/payout/mockupdatepayoutstatus","metadata":{"seo":{"title":"Mock update a payout status","description":"Mock update a payout status"}},"httpPath":"/payouts/mock"},{"type":"link","label":"Payout","link":"/api-documentation/apis/openapi/payout/payout","routeSlug":"/api-documentation/apis/openapi/payout/payout","httpVerb":"schema"}]},{"type":"group","label":"Beneficiary","link":"/api-documentation/apis/openapi/beneficiary","routeSlug":"/api-documentation/apis/openapi/beneficiary","items":[{"label":"List all Beneficiaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary/getbeneficiaries","routeSlug":"/api-documentation/apis/openapi/beneficiary/getbeneficiaries","metadata":{"seo":{"title":"List all Beneficiaries","description":"Returns a list of your beneficiaries. The beneficiaries are returned sorted by creation date, with the most recent beneficiary appearing first."}},"httpPath":"/beneficiaries"},{"label":"Retrieve a beneficiary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary/getbeneficiarybyid","routeSlug":"/api-documentation/apis/openapi/beneficiary/getbeneficiarybyid","metadata":{"seo":{"title":"Retrieve a beneficiary","description":"Retrieves details of a beneficiary."}},"httpPath":"/beneficiaries/{id}"},{"label":"Create a Beneficiary","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary/createbeneficiary","routeSlug":"/api-documentation/apis/openapi/beneficiary/createbeneficiary","metadata":{"seo":{"title":"Create a Beneficiary","description":"Creates a beneficiary with information such as name, contact, address, and banking information."}},"httpPath":"/beneficiaries"},{"type":"link","label":"Beneficiary","link":"/api-documentation/apis/openapi/beneficiary/beneficiary","routeSlug":"/api-documentation/apis/openapi/beneficiary/beneficiary","httpVerb":"schema"}]},{"type":"group","label":"Beneficiary V2","link":"/api-documentation/apis/openapi/beneficiary_v2","routeSlug":"/api-documentation/apis/openapi/beneficiary_v2","items":[{"label":"Create a Beneficiary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary_v2/createbeneficiaryv2","routeSlug":"/api-documentation/apis/openapi/beneficiary_v2/createbeneficiaryv2","metadata":{"seo":{"title":"Create a Beneficiary","description":"Creates a beneficiary with structured nested objects for beneficiary details, address, and bank account or UPI information."}},"httpPath":"/v2/beneficiaries"},{"label":"List Beneficiaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary_v2/listbeneficiariesv2","routeSlug":"/api-documentation/apis/openapi/beneficiary_v2/listbeneficiariesv2","metadata":{"seo":{"title":"List Beneficiaries","description":"Returns a paginated list of beneficiaries. Optionally filter by status."}},"httpPath":"/v2/beneficiaries"},{"label":"Get a Beneficiary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary_v2/getbeneficiarybyidv2","routeSlug":"/api-documentation/apis/openapi/beneficiary_v2/getbeneficiarybyidv2","metadata":{"seo":{"title":"Get a Beneficiary","description":"Retrieves the details of an existing beneficiary by ID."}},"httpPath":"/v2/beneficiaries/{id}"},{"label":"Mock Review a Beneficiary","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/beneficiary_v2/mockreviewbeneficiaryv2","routeSlug":"/api-documentation/apis/openapi/beneficiary_v2/mockreviewbeneficiaryv2","metadata":{"seo":{"title":"Mock Review a Beneficiary","description":"Simulates a review action (approve or reject) on a beneficiary. This endpoint is only available in sandbox/non-production environments."}},"httpPath":"/v2/beneficiaries/{id}/mock-review"},{"type":"link","label":"BeneficiaryV2","link":"/api-documentation/apis/openapi/beneficiary_v2/beneficiaryv2","routeSlug":"/api-documentation/apis/openapi/beneficiary_v2/beneficiaryv2","httpVerb":"schema"}]},{"type":"group","label":"Bank Account Validation","link":"/api-documentation/apis/openapi/bank_account_validation","routeSlug":"/api-documentation/apis/openapi/bank_account_validation","items":[{"label":"Validate any bank account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/bank_account_validation/validatebankaccount","routeSlug":"/api-documentation/apis/openapi/bank_account_validation/validatebankaccount","metadata":{"seo":{"title":"Validate any bank account","description":"Validate any bank account"}},"httpPath":"/bank_account_validation"},{"label":"List all bank account validations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/bank_account_validation/getbankaccountvalidations","routeSlug":"/api-documentation/apis/openapi/bank_account_validation/getbankaccountvalidations","metadata":{"seo":{"title":"List all bank account validations","description":"List all bank account validations"}},"httpPath":"/bank_account_validation"},{"type":"link","label":"BankAccountValidation","link":"/api-documentation/apis/openapi/bank_account_validation/bankaccountvalidation","routeSlug":"/api-documentation/apis/openapi/bank_account_validation/bankaccountvalidation","httpVerb":"schema"}]},{"type":"separator","label":"Document"},{"type":"group","label":"Document","link":"/api-documentation/apis/openapi/document","routeSlug":"/api-documentation/apis/openapi/document","items":[{"label":"Create a new document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/document/createdocument","routeSlug":"/api-documentation/apis/openapi/document/createdocument","metadata":{"seo":{"title":"Create a new document","description":"Create a new document"}},"httpPath":"/document"},{"label":"List all documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/document/getdocuments","routeSlug":"/api-documentation/apis/openapi/document/getdocuments","metadata":{"seo":{"title":"List all documents","description":"Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first."}},"httpPath":"/document"},{"label":"Get a document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/document/getdocumentbyid","routeSlug":"/api-documentation/apis/openapi/document/getdocumentbyid","metadata":{"seo":{"title":"Get a document by ID","description":"Retrieve a single document by its unique identifier."}},"httpPath":"/document/{document_id}"},{"type":"link","label":"Document","link":"/api-documentation/apis/openapi/document/document","routeSlug":"/api-documentation/apis/openapi/document/document","httpVerb":"schema"}]},{"type":"separator","label":"Internal Transfer"},{"type":"group","label":"Internal Transfer","link":"/api-documentation/apis/openapi/internal_transfer","routeSlug":"/api-documentation/apis/openapi/internal_transfer","items":[{"label":"Create an internal transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/internal_transfer/createinternaltransfer","routeSlug":"/api-documentation/apis/openapi/internal_transfer/createinternaltransfer","metadata":{"seo":{"title":"Create an internal transfer","description":"Creates an internal transfer between two merchant accounts."}},"httpPath":"/internal-transfer"},{"type":"link","label":"InternalTransfer","link":"/api-documentation/apis/openapi/internal_transfer/internaltransfer","routeSlug":"/api-documentation/apis/openapi/internal_transfer/internaltransfer","httpVerb":"schema"}]},{"type":"separator","label":"Settlement"},{"type":"group","label":"Settlement","link":"/api-documentation/apis/openapi/settlement","routeSlug":"/api-documentation/apis/openapi/settlement","items":[{"label":"Create a new settlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/settlement/createsettlement","routeSlug":"/api-documentation/apis/openapi/settlement/createsettlement","metadata":{"seo":{"title":"Create a new settlement","description":"Create a new settlement"}},"httpPath":"/settlements"},{"label":"List all settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/settlement/getsettlements","routeSlug":"/api-documentation/apis/openapi/settlement/getsettlements","metadata":{"seo":{"title":"List all settlements","description":"Returns a list of your settlements. The settlements are returned sorted by creation date, with the most recent settlement appearing first."}},"httpPath":"/settlements"},{"label":"Trigger a mock settlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/settlement/triggermocksettlement","routeSlug":"/api-documentation/apis/openapi/settlement/triggermocksettlement","metadata":{"seo":{"title":"Trigger a mock settlement","description":"This API is only available in sandbox mode. Queues a settlement run for your account so you can exercise settlements without a wait for the daily settlement schedule."}},"httpPath":"/settlements/mock-trigger"},{"label":"Retrieve a settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/settlement/getsettlementbyid","routeSlug":"/api-documentation/apis/openapi/settlement/getsettlementbyid","metadata":{"seo":{"title":"Retrieve a settlement","description":"Returns a specific settlement by its unique identifier."}},"httpPath":"/settlements/{id}"},{"label":"Retrieve transactions linked to a settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/settlement/gettransactionslinkedtosettlement","routeSlug":"/api-documentation/apis/openapi/settlement/gettransactionslinkedtosettlement","metadata":{"seo":{"title":"Retrieve transactions linked to a settlement","description":"Returns a list of transactions that are linked to a specific settlement by its unique identifier."}},"httpPath":"/settlements/{id}/transactions"},{"type":"link","label":"Settlement","link":"/api-documentation/apis/openapi/settlement/settlement","routeSlug":"/api-documentation/apis/openapi/settlement/settlement","httpVerb":"schema"}]},{"type":"separator","label":"Virtual Account"},{"type":"group","label":"Virtual Account","link":"/api-documentation/apis/openapi/virtual_account","routeSlug":"/api-documentation/apis/openapi/virtual_account","items":[{"label":"List all Virtual Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/virtual_account/getvirtualaccounts","routeSlug":"/api-documentation/apis/openapi/virtual_account/getvirtualaccounts","metadata":{"seo":{"title":"List all Virtual Accounts","description":"Returns the customer's virtual accounts, sorted by creation date (newest first), using the customer's JWT token for access."}},"httpPath":"/virtual-accounts"},{"label":"Close a Virtual Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/virtual_account/closevirtualaccount","routeSlug":"/api-documentation/apis/openapi/virtual_account/closevirtualaccount","metadata":{"seo":{"title":"Close a Virtual Account","description":"Closing active virtual accounts will be based on the specified payment type and currency. The endpoint closes all virtual accounts for a given payment type and currency. Once closed, the virtual account will no longer accept payments."}},"httpPath":"/virtual-accounts"},{"label":"Create a Virtual Account (v2)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/virtual_account/createvirtualaccountv2","routeSlug":"/api-documentation/apis/openapi/virtual_account/createvirtualaccountv2","metadata":{"seo":{"title":"Create a Virtual Account (v2)","description":"Creates a new virtual account with the specified payment type and currency. Virtual accounts provide unique account numbers that can be used to receive payments for customers. This endpoint returns HTTP 202 indicating the request has been accepted and is being processed. You will receive a webhook notification when the virtual account is activated."}},"httpPath":"/v2/virtual-accounts"},{"type":"link","label":"VirtualAccount","link":"/api-documentation/apis/openapi/virtual_account/virtualaccount","routeSlug":"/api-documentation/apis/openapi/virtual_account/virtualaccount","httpVerb":"schema"}]},{"type":"separator","label":"Platform"},{"type":"group","label":"Platform","link":"/api-documentation/apis/openapi/platform","routeSlug":"/api-documentation/apis/openapi/platform","items":[{"label":"Onboard a merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/platform/onboardmerchant","routeSlug":"/api-documentation/apis/openapi/platform/onboardmerchant","metadata":{"seo":{"title":"Onboard a merchant","description":"Allows platforms to onboard a new merchant onto Glomo."}},"httpPath":"/platform/merchants"},{"label":"Retrieve a merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/platform/getmerchant","routeSlug":"/api-documentation/apis/openapi/platform/getmerchant","metadata":{"seo":{"title":"Retrieve a merchant","description":"Retrieves details of a specific merchant by their merchant ID."}},"httpPath":"/platform/merchants/{merchant_id}"},{"label":"Update a merchant","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/platform/updatemerchant","routeSlug":"/api-documentation/apis/openapi/platform/updatemerchant","metadata":{"seo":{"title":"Update a merchant","description":"Updates an existing merchant. Currently supports attaching a passportobject for individual merchants and a registration_date for businessmerchants; more fields may be supported in future."}},"httpPath":"/platform/merchants/{merchant_id}"},{"label":"Update merchant status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/platform/updatemerchantstatus","routeSlug":"/api-documentation/apis/openapi/platform/updatemerchantstatus","metadata":{"seo":{"title":"Update merchant status","description":"Allows platforms to update the status of a merchant. This endpoint is available in non-production environments only."}},"httpPath":"/platform/merchants/status-update"},{"type":"link","label":"Merchant","link":"/api-documentation/apis/openapi/platform/merchant","routeSlug":"/api-documentation/apis/openapi/platform/merchant","httpVerb":"schema"}]},{"type":"separator","label":"KYC"},{"type":"group","label":"KYC Link","link":"/api-documentation/apis/openapi/kyclink","routeSlug":"/api-documentation/apis/openapi/kyclink","items":[{"label":"List KYC links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/kyclink/listkyclinks","routeSlug":"/api-documentation/apis/openapi/kyclink/listkyclinks","metadata":{"seo":{"title":"List KYC links","description":"Returns a list of KYC links. The links are returned sorted by creation date, with the most recent links appearing first. Optionally filter by status."}},"httpPath":"/kyc-links"},{"label":"Create a KYC link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/kyclink/createkyclink","routeSlug":"/api-documentation/apis/openapi/kyclink/createkyclink","metadata":{"seo":{"title":"Create a KYC link","description":"Creates a KYC link that can be shared with a customer to complete identity verification. Optionally associate with an existing customer via customer_id, or with a new customer via email. Both fields are optional and mutually exclusive — passing both will return a 400 error. Omitting both creates an unlinked KYC link."}},"httpPath":"/kyc-links"},{"label":"Retrieve a KYC link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/kyclink/getkyclinkbyid","routeSlug":"/api-documentation/apis/openapi/kyclink/getkyclinkbyid","metadata":{"seo":{"title":"Retrieve a KYC link","description":"Retrieves the details of a KYC link by its unique identifier, including the verification status, customer ID and the list of KYC documents submitted."}},"httpPath":"/kyc-links/{id}"},{"type":"link","label":"KycLinkDetail","link":"/api-documentation/apis/openapi/kyclink/kyclinkdetail","routeSlug":"/api-documentation/apis/openapi/kyclink/kyclinkdetail","httpVerb":"schema"}]},{"type":"separator","label":"Investor Portal"},{"type":"group","label":"Investor Journey","link":"/api-documentation/apis/openapi/investor_journey","routeSlug":"/api-documentation/apis/openapi/investor_journey","items":[{"label":"Create investor journey","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/investor_journey/createinvestorjourney","routeSlug":"/api-documentation/apis/openapi/investor_journey/createinvestorjourney","metadata":{"seo":{"title":"Create investor journey","description":"Creates an investor portal URL for the given email, PAN, and scheme. Requires a platform merchant JWT."}},"httpPath":"/investor-journey"}]},{"type":"separator","label":"Request for Information"},{"type":"group","label":"RFI","link":"/api-documentation/apis/openapi/rfi","routeSlug":"/api-documentation/apis/openapi/rfi","items":[{"label":"List RFIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/rfi/getrfis","routeSlug":"/api-documentation/apis/openapi/rfi/getrfis","metadata":{"seo":{"title":"List RFIs","description":"Returns your business's RFIs across every entity type — payments, payins, payouts, refunds, orders and subscriptions — not just a single resource. Use status and search to filter the list, and the pagination parameters to page through results. Results are ordered by created_at descending."}},"httpPath":"/rfis"},{"label":"Fetch an RFI","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/rfi/getrfi","routeSlug":"/api-documentation/apis/openapi/rfi/getrfi","metadata":{"seo":{"title":"Fetch an RFI","description":"Returns the full detail of a single RFI, including its status, the documents required to resolve it, the instructions to follow, and any reviewer or uploader comments. The RFI is looked up by its id (starting with rfi_), exposed on the underlying resource (for example the rfi object on a Payment) or in the List RFIs response."}},"httpPath":"/rfis/{id}"},{"label":"Respond to an RFI","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/apis/openapi/rfi/respondrfi","routeSlug":"/api-documentation/apis/openapi/rfi/respondrfi","metadata":{"seo":{"title":"Respond to an RFI","description":"Submits the documents requested by a Request for Information (RFI). An RFI is raised when Glomo's compliance checks need additional information — for example, a sanctions-screening hold — before a transaction can be completed. Respond to it using the RFI id exposed on the underlying resource (for example, the rfi.id field on a Payment)."}},"httpPath":"/rfis/{id}/respond"}]}],"expanded":"true"}]}