# vrtx Docs ## Docs - [Welcome 👋](https://docs.staging.vrtx.sa/welcome-1806128m0.md): - [Get Started](https://docs.staging.vrtx.sa/get-started-1806127m0.md): - [Payouts](https://docs.staging.vrtx.sa/payouts-5719034f0.md): - [Welcome 👋](https://docs.staging.vrtx.sa/welcome-1807548m0.md): - [Get Started](https://docs.staging.vrtx.sa/get-started-1807549m0.md): - [Authentication](https://docs.staging.vrtx.sa/authentication-1807550m0.md): - [Responses](https://docs.staging.vrtx.sa/responses-1807551m0.md): - [Pagination](https://docs.staging.vrtx.sa/pagination-1807552m0.md): ## API Docs - Auth [Token](https://docs.staging.vrtx.sa/token-24712037e0.md): Authenticates a partner using API key and secret, returning a short-lived bearer token scoped to allowed operations. - Onboarding [Start onboarding](https://docs.staging.vrtx.sa/start-onboarding-24712038e0.md): - Onboarding [Verify onboarding OTP](https://docs.staging.vrtx.sa/verify-onboarding-otp-24712039e0.md): - Onboarding [Resend onboarding OTP](https://docs.staging.vrtx.sa/resend-onboarding-otp-24712040e0.md): - Onboarding [Get session status](https://docs.staging.vrtx.sa/get-session-status-25132611e0.md): - Onboarding [Initiate Nafath](https://docs.staging.vrtx.sa/initiate-nafath-24712042e0.md): - Onboarding [Cancels session](https://docs.staging.vrtx.sa/cancels-session-24712043e0.md): - Onboarding [Complete customer info](https://docs.staging.vrtx.sa/complete-customer-info-24712044e0.md): - Wallet > Change mobile number from profile settings [Change mobile number](https://docs.staging.vrtx.sa/change-mobile-number-24712048e0.md): - Wallet > Change mobile number from profile settings [Verify mobile number change OTP](https://docs.staging.vrtx.sa/verify-mobile-number-change-otp-24712049e0.md): - Wallet > Change mobile number from profile settings [Get mobile change status](https://docs.staging.vrtx.sa/get-mobile-change-status-25132612e0.md): - Wallet > Change mobile number from login screen [Change mobile number](https://docs.staging.vrtx.sa/change-mobile-number-24712051e0.md): - Wallet > Change mobile number from login screen [Verify mobile number change OTP](https://docs.staging.vrtx.sa/verify-mobile-number-change-otp-24712052e0.md): - Wallet > Change mobile number from login screen [Initiate Nafath](https://docs.staging.vrtx.sa/initiate-nafath-24712053e0.md): - Wallet > Change mobile number from login screen [Get mobile number change status](https://docs.staging.vrtx.sa/get-mobile-number-change-status-25132613e0.md): - Payouts [Create payout](https://docs.staging.vrtx.sa/create-payout-24712061e0.md): - Payouts [Get payout status](https://docs.staging.vrtx.sa/get-payout-status-25132619e0.md): - Payouts [Create bulk payout](https://docs.staging.vrtx.sa/create-bulk-payout-24712063e0.md): Uploads a CSV file to storage and kicks off a payout batch. Clients must supply an idempotency key via the idempotency-key header. - Payouts [Get bulk payout status](https://docs.staging.vrtx.sa/get-bulk-payout-status-25132620e0.md): Retrieves processing progress, totals, and success rates for a bulk payout batch. - Payouts [Get batch report](https://docs.staging.vrtx.sa/get-batch-report-25132621e0.md): Retrieves a detailed report for a bulk payout batch, including payouts and summary. - Cards > Issuance [Issue card](https://docs.staging.vrtx.sa/issue-card-24712066e0.md): - Cards > Issuance [Get card issuance](https://docs.staging.vrtx.sa/get-card-issuance-25132622e0.md): - Cards > Issuance [Complete card issuance](https://docs.staging.vrtx.sa/complete-card-issuance-25132623e0.md): - Cards > Issuance [Verify card issuance OTP](https://docs.staging.vrtx.sa/verify-card-issuance-otp-25132624e0.md): - Cards > Issuance [Convert virtual to physical](https://docs.staging.vrtx.sa/convert-virtual-to-physical-24712070e0.md): - Cards > Issuance [Verify card conversion OTP](https://docs.staging.vrtx.sa/verify-card-conversion-otp-24712071e0.md): - Cards > Management [Get card](https://docs.staging.vrtx.sa/get-card-24712072e0.md): - Cards > Management [Change card status](https://docs.staging.vrtx.sa/change-card-status-24712073e0.md): - Cards > Management [Set or update card PIN](https://docs.staging.vrtx.sa/set-or-update-card-pin-24712074e0.md): - Cards > Management [Verify card PIN OTP](https://docs.staging.vrtx.sa/verify-card-pin-otp-24712075e0.md): - Cards > Management [Activate physical card](https://docs.staging.vrtx.sa/activate-physical-card-25132625e0.md): - Cards > Management [Verify activation OTP](https://docs.staging.vrtx.sa/verify-activation-otp-24712077e0.md): - Cards > Management [Display sensitive data](https://docs.staging.vrtx.sa/display-sensitive-data-25132626e0.md): - Cards > Management [Verify display sensitive data OTP](https://docs.staging.vrtx.sa/verify-display-sensitive-data-otp-25132627e0.md): - Transactions > Business Accounts [Get business account balance](https://docs.staging.vrtx.sa/get-business-account-balance-25132614e0.md): - Transactions > Business Accounts [Get transaction details](https://docs.staging.vrtx.sa/get-transaction-details-25132615e0.md): - Transactions > Business Accounts [List business transactions](https://docs.staging.vrtx.sa/list-business-transactions-25132616e0.md): - Transactions > Wallet Accounts [Get wallet balance](https://docs.staging.vrtx.sa/get-wallet-balance-25132617e0.md): - Transactions > Wallet Accounts [List wallet transactions](https://docs.staging.vrtx.sa/list-wallet-transactions-25132618e0.md): - cards [Initiate card replacement](https://docs.staging.vrtx.sa/initiate-card-replacement-25132628e0.md): - cards [Verify OTP and complete card replacement](https://docs.staging.vrtx.sa/verify-otp-and-complete-card-replacement-25132629e0.md): - [Start onboarding](https://docs.staging.vrtx.sa/start-onboarding-24712038e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - [Verify onboarding OTP](https://docs.staging.vrtx.sa/verify-onboarding-otp-24712039e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - [Resend onboarding OTP](https://docs.staging.vrtx.sa/resend-onboarding-otp-24712040e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - [Get session status](https://docs.staging.vrtx.sa/get-session-status-25132611e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - [Initiate Nafath](https://docs.staging.vrtx.sa/initiate-nafath-24712042e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - [Cancels session](https://docs.staging.vrtx.sa/cancels-session-24712043e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - [Complete customer info](https://docs.staging.vrtx.sa/complete-customer-info-24712044e0.md?nav=01KATTF327GHEZF5AA1FJT1W49): - Change mobile number from profile settings [Change mobile number](https://docs.staging.vrtx.sa/change-mobile-number-24712048e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - Change mobile number from profile settings [Verify mobile number change OTP](https://docs.staging.vrtx.sa/verify-mobile-number-change-otp-24712049e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - Change mobile number from profile settings [Get mobile change status](https://docs.staging.vrtx.sa/get-mobile-change-status-25132612e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - Change mobile number from login screen [Change mobile number](https://docs.staging.vrtx.sa/change-mobile-number-24712051e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - Change mobile number from login screen [Verify mobile number change OTP](https://docs.staging.vrtx.sa/verify-mobile-number-change-otp-24712052e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - Change mobile number from login screen [Initiate Nafath](https://docs.staging.vrtx.sa/initiate-nafath-24712053e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - Change mobile number from login screen [Get mobile number change status](https://docs.staging.vrtx.sa/get-mobile-number-change-status-25132613e0.md?nav=01KATTFKQNETQY5FH08XR4MB0S): - [Create payout](https://docs.staging.vrtx.sa/create-payout-24712061e0.md?nav=01KATTG3PEV42E6848GTXF0NXN): - [Get payout status](https://docs.staging.vrtx.sa/get-payout-status-25132619e0.md?nav=01KATTG3PEV42E6848GTXF0NXN): - [Create bulk payout](https://docs.staging.vrtx.sa/create-bulk-payout-24712063e0.md?nav=01KATTG3PEV42E6848GTXF0NXN): Uploads a CSV file to storage and kicks off a payout batch. Clients must supply an idempotency key via the idempotency-key header. - [Get bulk payout status](https://docs.staging.vrtx.sa/get-bulk-payout-status-25132620e0.md?nav=01KATTG3PEV42E6848GTXF0NXN): Retrieves processing progress, totals, and success rates for a bulk payout batch. - [Get batch report](https://docs.staging.vrtx.sa/get-batch-report-25132621e0.md?nav=01KATTG3PEV42E6848GTXF0NXN): Retrieves a detailed report for a bulk payout batch, including payouts and summary. - Issuance [Issue card](https://docs.staging.vrtx.sa/issue-card-24712066e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Issuance [Get card issuance](https://docs.staging.vrtx.sa/get-card-issuance-25132622e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Issuance [Complete card issuance](https://docs.staging.vrtx.sa/complete-card-issuance-25132623e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Issuance [Verify card issuance OTP](https://docs.staging.vrtx.sa/verify-card-issuance-otp-25132624e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Issuance [Convert virtual to physical](https://docs.staging.vrtx.sa/convert-virtual-to-physical-24712070e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Issuance [Verify card conversion OTP](https://docs.staging.vrtx.sa/verify-card-conversion-otp-24712071e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Get card](https://docs.staging.vrtx.sa/get-card-24712072e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Change card status](https://docs.staging.vrtx.sa/change-card-status-24712073e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Set or update card PIN](https://docs.staging.vrtx.sa/set-or-update-card-pin-24712074e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Verify card PIN OTP](https://docs.staging.vrtx.sa/verify-card-pin-otp-24712075e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Activate physical card](https://docs.staging.vrtx.sa/activate-physical-card-25132625e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Verify activation OTP](https://docs.staging.vrtx.sa/verify-activation-otp-24712077e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Display sensitive data](https://docs.staging.vrtx.sa/display-sensitive-data-25132626e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Management [Verify display sensitive data OTP](https://docs.staging.vrtx.sa/verify-display-sensitive-data-otp-25132627e0.md?nav=01KATT9J6XMW6M4E2HFQ10A1F6): - Business Accounts [Get business account balance](https://docs.staging.vrtx.sa/get-business-account-balance-25132614e0.md?nav=01KATTGQHAT429NDR4QDK8GP56): - Business Accounts [Get transaction details](https://docs.staging.vrtx.sa/get-transaction-details-25132615e0.md?nav=01KATTGQHAT429NDR4QDK8GP56): - Business Accounts [List business transactions](https://docs.staging.vrtx.sa/list-business-transactions-25132616e0.md?nav=01KATTGQHAT429NDR4QDK8GP56): - Wallet Accounts [Get wallet balance](https://docs.staging.vrtx.sa/get-wallet-balance-25132617e0.md?nav=01KATTGQHAT429NDR4QDK8GP56): - Wallet Accounts [List wallet transactions](https://docs.staging.vrtx.sa/list-wallet-transactions-25132618e0.md?nav=01KATTGQHAT429NDR4QDK8GP56): - Auth [Token](https://docs.staging.vrtx.sa/token-24814161e0.md): Obtain an access token. - Businesses [List businesses](https://docs.staging.vrtx.sa/list-businesses-24814162e0.md): Retrieve all businesses that the closed-loop orchestrator manages. - Businesses [Create business](https://docs.staging.vrtx.sa/create-business-24814163e0.md): Create a business entity in the closed-loop ecosystem. - Money Movement [Create fund](https://docs.staging.vrtx.sa/create-fund-24814164e0.md): Fund a business account within the closed-loop ecosystem to enable payouts, wallet top-ups, and internal transfers. - Money Movement [Create payout](https://docs.staging.vrtx.sa/create-payout-24814165e0.md): Move funds from a business operational account to one or more wallets inside the closed-loop ecosystem. - Money Movement [Get payout](https://docs.staging.vrtx.sa/get-payout-24814166e0.md): Retrieve a payout by transaction identifier to inspect its final state and metadata. - Money Movement [Create refund](https://docs.staging.vrtx.sa/create-refund-24814167e0.md): Move funds from one or more wallets back to the business operational account within the closed-loop ecosystem. - Money Movement [Create transfer](https://docs.staging.vrtx.sa/create-transfer-24814168e0.md): Transfer funds between wallets within the closed-loop ecosystem. - Money Movement [Create withdrawal](https://docs.staging.vrtx.sa/create-withdrawal-24814169e0.md): Withdraw funds from a business operational account or a wallet to the clearance wallet, representing settlement or reconciliation outside the closed-loop system. - Labels [List labels](https://docs.staging.vrtx.sa/list-labels-24814170e0.md): Return all labels available in the closed-loop ecosystem. - Labels [Create label](https://docs.staging.vrtx.sa/create-label-24814171e0.md): Create a new label that can be assigned to wallets, business accounts, or transactions within the closed-loop ecosystem. - Transactions [List transactions](https://docs.staging.vrtx.sa/list-transactions-24814172e0.md): Retrieve all transactions recorded in the closed-loop system. - Transactions [Get transaction](https://docs.staging.vrtx.sa/get-transaction-24814173e0.md): Retrieve a single transaction and its ledger attributes by ID. - Transactions [List wallet transactions](https://docs.staging.vrtx.sa/list-wallet-transactions-24814174e0.md): Retrieve all transactions related to a specific wallet in the closed-loop ecosystem. - Wallets [List wallets](https://docs.staging.vrtx.sa/list-wallets-24814175e0.md): Retrieve all wallets available in the closed-loop ecosystem. - Wallets [Create wallet](https://docs.staging.vrtx.sa/create-wallet-24814176e0.md): Create a new wallet under a closed-loop business account. - Wallets [Lookup wallet](https://docs.staging.vrtx.sa/lookup-wallet-24814177e0.md): Retrieve wallet details by account number or external reference. - Wallets [Update wallet](https://docs.staging.vrtx.sa/update-wallet-24814178e0.md): Update editable metadata of a wallet that is linked to a closed-loop business account. - Wallets [Get wallet](https://docs.staging.vrtx.sa/get-wallet-24814179e0.md): Retrieve detailed information about a specific wallet by its unique walletId. - Wallets [Get wallet balance](https://docs.staging.vrtx.sa/get-wallet-balance-24814180e0.md): Return the current available balance for a wallet in both major and minor units. - Wallets [Remove label](https://docs.staging.vrtx.sa/remove-label-24814181e0.md): Unassign a label from a specific wallet within the closed-loop system. - Wallets [Assign label](https://docs.staging.vrtx.sa/assign-label-24814182e0.md): Assign an existing label to a specific wallet in the closed-loop system. - Wallet Statements [Retrieve wallet statement (preview)](https://docs.staging.vrtx.sa/retrieve-wallet-statement-preview-24814183e0.md): This operation is visible for integration planning but is not yet enabled. - Webhooks [Register webhook endpoint (preview)](https://docs.staging.vrtx.sa/register-webhook-endpoint-preview-24814184e0.md): This operation is visible for integration planning but is not yet enabled. - Webhooks [List webhook endpoints (preview)](https://docs.staging.vrtx.sa/list-webhook-endpoints-preview-24814185e0.md): This operation is visible for integration planning but is not yet enabled. - Card Transactions [Perform a simulated card transaction](https://docs.staging.vrtx.sa/perform-a-simulated-card-transaction-24962415e0.md): Sends a realistic ISO8583 authorization to FAST and returns a summarized result. - Card Transactions [Perform a balance inquiry](https://docs.staging.vrtx.sa/perform-a-balance-inquiry-24962419e0.md): Builds a FAST 0100 message for an ATM balance inquiry (SAR, Saudi acquirer defaults).