API reference

Fintwin provides every API below. The enterprise calls HTTPS POST JSON. Pick an API to see its fields and code samples, and try it.

Debit mandate Batch debit Near-real-time debit Payout Virtual account and VietQR Account linking Linked-account payment Inquiries

Debit mandate

Register and cancel a debit mandate from the enterprise app.

POSTRegister mandate/api/v1/end-user/autodebit-register Authorization + AES POSTConfirm registration/api/v1/end-user/autodebit-register-confirm Authorization + AES POSTCancel mandate/api/v1/end-user/autodebit-cancel Authorization + AES POSTConfirm cancellation/api/v1/end-user/autodebit-cancel-confirm Authorization + AES

Batch debit

Create a batch, query status, refund, and exchange files.

POSTCreate debit batch/api/v1/cms_create_ad_batchSchema in review Authorization + signature POSTBatch status/api/v1/cms_status_ad_batchSchema in review Authorization + signature POSTRefund a debit/api/v1/cms_refund_ad_by_fwSchema in review Authorization + signature POSTCreate batch v2/api/v1/batch-req/ad-make-batchSchema in review Authorization + signature POSTBatch status v2/api/v1/batch-req/ad-status-batchSchema in review Authorization + signature POSTUpload batch file/api/v1/batch-file/cms_upload_batch_requestSchema in review Authorization + signature POSTCheck batch file result/api/v1/batch-file/cms_check_batch_resultSchema in review Authorization + signature POSTDownload batch result/api/v1/batch-file/cms_download_batch_resultSchema in review Authorization + signature POSTUpload batch as JSON/api/v1/batch-file-base64/upload-batch-file Authorization + signature POSTCheck JSON batch file/api/v1/batch-file-base64/check-batch-fileSchema in review Authorization + signature POSTDownload result as JSON/api/v1/batch-file-base64/download-result-batch-fileSchema in review Authorization + signature

Near-real-time debit

Debit a single amount from a mandated account.

POSTReal-time debit/api/v1/cms_3800 Authorization POSTSingle async collection/api/v1/single-async-ad/thu_hoSchema in review Authorization + signature POSTCheck single collection/api/v1/single-async-ad/check-thu-hoSchema in review Authorization + signature

Payout

Single transfer and status inquiry.

POSTSingle payout/api/v1/cms_1100 Authorization + signature POSTTransaction status/api/v1/cms_6013 Authorization

Virtual account and VietQR

Virtual account lifecycle and VietQR generation.

POSTCreate virtual account/api/v1/va_8100 Authorization POSTUpdate virtual account/api/v1/va_8200 Authorization POSTDelete virtual account/api/v1/va_8300 Authorization POSTGenerate VietQR/api/v1/partner/gen-viet-qr Authorization

Account linking

Link, confirm, unlink, and query link state.

POSTStart account link/api/v1/end_user_topup/link-topup Authorization + signature POSTConfirm link/api/v1/end_user_topup/confirm-topup Authorization + signature POSTUnlink account/api/v1/end_user_topup/unlink-topup Authorization + signature POSTQuery link/api/v1/end_user_topup/get-link Authorization + signature

Linked-account payment

Initiate, confirm, query, and refund a payment.

POSTInitiate payment/api/v1/topups/initiate-topupSchema in review Authorization + signature POSTConfirm payment/api/v1/topups/confirm-topupSchema in review Authorization + signature POSTQuery payment/api/v1/topups/query-topupSchema in review Authorization + signature POSTRefund payment/api/v1/topups/refund-topupSchema in review Authorization + signature

Inquiries

Balance, account name, detail, invoice, and bank list.

POSTAccount balance/api/v1/cms_2100 Authorization POSTAccount holder name/api/v1/cms_4100 Authorization POSTAccount detail by customer id/api/v1/cms_4200 Authorization POSTTransactions for an invoice/api/v1/cms_6100 Authorization POSTBank list/api/v1/cms_bank_lst Authorization