> For the complete documentation index, see [llms.txt](https://docs.pagsmile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagsmile.com/reference/remittance-api.md).

# Remittance API

- [Getting Started](https://docs.pagsmile.com/reference/remittance-api/getting-started.md)
- [Environments](https://docs.pagsmile.com/reference/remittance-api/environments.md)
- [Security](https://docs.pagsmile.com/reference/remittance-api/security.md): How to make safe issuing card requests.
- [Common](https://docs.pagsmile.com/reference/remittance-api/common.md): Introduce the input and output parameters of the request
- [Business](https://docs.pagsmile.com/reference/remittance-api/business.md): Use the Business APIs to onboard merchants, manage accounts and beneficiaries, initiate remittance operations, reconcile balances and transactions, and receive webhooks.
- [Onboarding](https://docs.pagsmile.com/reference/remittance-api/business/onboarding.md): Create, update, and query corporate merchant profiles, including business, director, address, and ultimate beneficial owner (UBO) information.
- [Create Corporate Merchant](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/create-corporation.md): Onboards a corporate merchant by submitting its contact, business, director, and ultimate beneficial owner (UBO) information.
- [Update Corporate Merchant](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/update-corporation.md): Updates the onboarding profile of an existing corporate merchant, including its business, director, address, and UBO information.
- [Query Corporate Merchant](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/query-corporation.md): Retrieves the current onboarding profile and review status of a corporate merchant.
- [Create Individual](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/create-individual.md): Creates an individual merchant profile with identity, contact, and residential address information.
- [Update Individual](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/update-individual.md): Updates the identity, contact, and residential address information of an existing individual merchant.
- [Query Individual](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/query-individual.md): Retrieves the current profile and onboarding status of an individual merchant.
- [Add Shop](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/add-shop.md): Adds a shop or sales channel to an existing merchant profile.
- [Delete Shop](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/delete-shop.md): Removes a shop from a merchant profile by using its unique shop identifier.
- [Query Shops](https://docs.pagsmile.com/reference/remittance-api/business/onboarding/query-shops.md): Retrieves shops associated with a merchant, with optional filters and pagination.
- [Material](https://docs.pagsmile.com/reference/remittance-api/business/material.md): Create and maintain supporting trade materials, upload documents, and manage associations between materials and transactions.
- [Create Material](https://docs.pagsmile.com/reference/remittance-api/business/material/create-material.md): Creates a trade material record and associates the supporting documents required for collection or payment review.
- [Update Material](https://docs.pagsmile.com/reference/remittance-api/business/material/update-material.md): Updates the business details of an existing trade material record.
- [Supplementary Material Document](https://docs.pagsmile.com/reference/remittance-api/business/material/supplementary-material-document.md): Adds supporting documents to an existing material record or related transaction.
- [Query Materials](https://docs.pagsmile.com/reference/remittance-api/business/material/query-materials.md): Retrieves trade material records for a merchant within a specified time range, with optional filters and pagination.
- [Link Material](https://docs.pagsmile.com/reference/remittance-api/business/material/link-material.md): Associates an approved material record with one or more collection or payment transactions.
- [Cancel Association](https://docs.pagsmile.com/reference/remittance-api/business/material/cancel-association.md): Removes an existing association between a material record and a transaction.
- [Query Material Links](https://docs.pagsmile.com/reference/remittance-api/business/material/query-material-links.md): Retrieves material-to-transaction associations within a specified time range.
- [Collection](https://docs.pagsmile.com/reference/remittance-api/business/collection.md): Create and manage collection accounts, track application outcomes, query incoming collection transactions, and process collection notifications.
- [Apply Collection Account](https://docs.pagsmile.com/reference/remittance-api/business/collection/apply-collection-account.md): Applies for one or more collection accounts for a merchant and specified business scenario.
- [Query Apply Collection Account Result](https://docs.pagsmile.com/reference/remittance-api/business/collection/query-apply-collection-account-result.md): Retrieves the latest review result and created account identifiers for a collection account application.
- [Apply Collection Account Result Notification](https://docs.pagsmile.com/reference/remittance-api/business/collection/apply-collection-account-result-notification.md): Notifies the partner when a collection account application is reviewed and provides the latest application status and created account identifiers.
- [Query Collection Account Detail](https://docs.pagsmile.com/reference/remittance-api/business/collection/query-collection-account-detail.md): Retrieves the configuration and current status of a specific collection account.
- [Query Collection Accounts](https://docs.pagsmile.com/reference/remittance-api/business/collection/query-collection-accounts.md): Retrieves collection accounts for a merchant within a specified time range, with optional filters and pagination.
- [Collection Notification](https://docs.pagsmile.com/reference/remittance-api/business/collection/collection-notification.md): Notifies the partner when funds arrive in a merchant collection account and provides the transaction and sender details needed for reconciliation.
- [Query Collections](https://docs.pagsmile.com/reference/remittance-api/business/collection/query-collections.md): Retrieves incoming collection transactions for a merchant within a specified time range, with optional account filters and pagination.
- [Store](https://docs.pagsmile.com/reference/remittance-api/business/store.md): Create, update, and query the stores or commerce platforms associated with a merchant.
- [Create Store](https://docs.pagsmile.com/reference/remittance-api/business/store/create-store.md): Creates a store or commerce platform record for a merchant.
- [Update Store](https://docs.pagsmile.com/reference/remittance-api/business/store/update-store.md): Updates the business and channel information of an existing store.
- [Query Stores](https://docs.pagsmile.com/reference/remittance-api/business/store/query-stores.md): Retrieves stores associated with a merchant within a specified time range, with optional filters and pagination.
- [Exchange](https://docs.pagsmile.com/reference/remittance-api/business/exchange.md): Retrieve exchange quotes, create exchange orders, and reconcile exchange results.
- [Query Support Currency Pairs](https://docs.pagsmile.com/reference/remittance-api/business/exchange/query-support-currency-pairs.md): Retrieves the currency pairs currently supported for foreign exchange.
- [Query Quote](https://docs.pagsmile.com/reference/remittance-api/business/exchange/query-quote.md): Returns an executable foreign-exchange quote for a currency pair, amount, and fixed side.
- [Create Exchange Order](https://docs.pagsmile.com/reference/remittance-api/business/exchange/create-exchange-order.md): Creates a foreign-exchange order from a valid quote and merchant-defined order number.
- [Query Exchange Orders](https://docs.pagsmile.com/reference/remittance-api/business/exchange/query-exchange-orders.md): Retrieves exchange orders for a merchant within a specified time range, with optional filters and pagination.
- [Payment](https://docs.pagsmile.com/reference/remittance-api/business/payment.md): Manage beneficiaries, create payment orders, query payment results, and process payment status notifications.
- [Query Payment Fields](https://docs.pagsmile.com/reference/remittance-api/business/payment/query-payment-fields.md): Returns the beneficiary fields and validation rules required for a selected country, currency, payment type, and account type.
- [Create Beneficiary](https://docs.pagsmile.com/reference/remittance-api/business/payment/create-beneficiary.md): Creates a reusable payment beneficiary and validates the destination account details required by the selected payment route.
- [Update Beneficiary](https://docs.pagsmile.com/reference/remittance-api/business/payment/update-beneficiary.md): Updates the destination account or profile information of an existing beneficiary.
- [Delete Beneficiary](https://docs.pagsmile.com/reference/remittance-api/business/payment/delete-beneficiary.md): Deletes an existing beneficiary from the merchant's beneficiary list.
- [Query Beneficiary Detail](https://docs.pagsmile.com/reference/remittance-api/business/payment/query-beneficiary-detail.md): Retrieves the current details of a specific beneficiary.
- [Create Payment Order](https://docs.pagsmile.com/reference/remittance-api/business/payment/create-payment-order.md): Creates a payment order from a merchant account to a previously registered beneficiary.
- [Query Payment Orders](https://docs.pagsmile.com/reference/remittance-api/business/payment/query-payment-orders.md): Retrieves payment orders for a merchant within a specified time range, with optional filters and pagination.
- [Payment Result Notification](https://docs.pagsmile.com/reference/remittance-api/business/payment/payment-result-notification.md): Notifies the partner when a payment order changes status and provides the settlement, fee, refund, and error details required for reconciliation.
- [Withdrawal](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal.md): Manage withdrawal accounts, create withdrawal orders, query results, and process withdrawal status notifications.
- [Add Withdrawal Account](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/add-withdrawal-account.md): Creates a reusable withdrawal account for a merchant and validates the destination bank details.
- [Update Withdrawal Account](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/update-withdrawal-account.md): Updates the bank account or beneficiary information of an existing withdrawal account.
- [Delete Withdrawal Account](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/delete-withdrawal-account.md): Deletes an existing withdrawal account from the merchant's account list.
- [Query Withdrawal Account Detail](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/query-withdrawal-account-detail.md): Retrieves the current details of a specific withdrawal account.
- [Create Withdrawal Order](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/create-withdrawal-order.md): Creates a withdrawal order to transfer funds from a merchant account to a registered or inline payee.
- [Query Withdrawal Orders](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/query-withdrawal-orders.md): Retrieves withdrawal orders for a merchant within a specified time range, with optional filters and pagination.
- [Withdrawal Result Notification](https://docs.pagsmile.com/reference/remittance-api/business/withdrawal/withdrawal-result-notification.md): Notifies the partner when a withdrawal order changes status and provides the settlement, fee, refund, and error details required for reconciliation.
- [Transfer](https://docs.pagsmile.com/reference/remittance-api/business/transfer.md): Move funds between eligible accounts within the Pagsmile remittance platform.
- [Internal transfer](https://docs.pagsmile.com/reference/remittance-api/business/transfer/internal-transfer.md): Transfers funds between a merchant account and an eligible partner account without using an external payment rail.
- [Merchant Balance](https://docs.pagsmile.com/reference/remittance-api/business/merchant-account.md): Retrieve merchant account balances and reconcile account-level transactions.
- [Query Account Balance](https://docs.pagsmile.com/reference/remittance-api/business/merchant-account/query-account-balance.md): Retrieves the total, available, and blocked balances of a merchant account by currency.
- [Query Account Transactions](https://docs.pagsmile.com/reference/remittance-api/business/merchant-account/query-account-transactions.md): Retrieves merchant account transactions for a date range, with optional currency, transaction, status, and pagination filters.
- [Partner Balance](https://docs.pagsmile.com/reference/remittance-api/business/partner.md): Retrieve partner balances and reconcile partner-level transactions.
- [Create Topup Order](https://docs.pagsmile.com/reference/remittance-api/business/partner/create-topup-order.md): Creates a top-up order to add funds to a partner balance and records the expected incoming payment details.
- [Query Topup Result](https://docs.pagsmile.com/reference/remittance-api/business/partner/query-topup-result.md): Retrieves the processing result and credited amount of a partner top-up order.
- [Query Partner Balance](https://docs.pagsmile.com/reference/remittance-api/business/partner/query-partner-balance.md): Retrieves the total, available, and blocked partner balances grouped by currency.
- [Query Partner Transactions](https://docs.pagsmile.com/reference/remittance-api/business/partner/query-partner-transactions.md): Retrieves partner-level balance transactions for a date range, with optional filters and pagination.
- [Webhook](https://docs.pagsmile.com/reference/remittance-api/business/webhook.md): Configure webhook delivery and understand the common notification envelope used by Remittance API events.
- [Webhook Common](https://docs.pagsmile.com/reference/remittance-api/business/webhook/webhook-common.md): Defines the common HTTP request envelope, signing fields, and acknowledgment requirements used by Remittance API notifications.
- [Manage URL](https://docs.pagsmile.com/reference/remittance-api/business/webhook/manage-url.md): Create, update, and query the callback URLs used to receive Remittance API notifications.
- [Create Webhook URL](https://docs.pagsmile.com/reference/remittance-api/business/webhook/manage-url/create-webhook-url.md): Registers a callback URL for one or more Remittance API notification types.
- [Update Webhook URL](https://docs.pagsmile.com/reference/remittance-api/business/webhook/manage-url/update-webhook-url.md): Updates an existing callback URL, description, or notification type configuration.
- [Query Webhook URL](https://docs.pagsmile.com/reference/remittance-api/business/webhook/manage-url/query-webhook-url.md): Retrieves the webhook endpoints currently configured for the partner.
- [Reference](https://docs.pagsmile.com/reference/remittance-api/business/reference.md): Use supporting endpoints to discover banks and upload documents referenced by Business API requests.
- [Upload Material Document](https://docs.pagsmile.com/reference/remittance-api/business/reference/upload-material-document.md): Uploads a supporting document and returns the file identifier used by material and compliance requests.
- [Query Bank List](https://docs.pagsmile.com/reference/remittance-api/business/reference/query-bank-list.md): Retrieves banks supported for a specified country, currency, and payment route.
- [Data](https://docs.pagsmile.com/reference/remittance-api/data.md)
- [Dictionary Item](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item.md)
- [Business Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/business-type.md)
- [Business Category](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/business-category.md)
- [Webhook Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/webhook-type.md)
- [All Audit Status](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/all-audit-status.md)
- [Transaction Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/transaction-type.md)
- [Transaction Status](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/transaction-status.md)
- [Gender](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/gender.md)
- [Id Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/id-type.md)
- [Material File Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/material-file-type.md)
- [Fixed Side](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/fixed-side.md)
- [Order Status](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/order-status.md)
- [Payment Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/payment-type.md)
- [Account Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/account-type.md)
- [Payee Type](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/payee-type.md)
- [Currency](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/currency.md)
- [CHARSETS](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/charsets.md)
- [Country Code](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/country-code.md)
- [Platform](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/platform.md)
- [Industry Category](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/industry-category.md)
- [Business Scenes](https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/business-scenes.md)
- [Trade Currency](https://docs.pagsmile.com/reference/remittance-api/data/trade-currency.md)