### Get product by ID Source: https://api.gsalary.com/api Returns catalog detail when the SKU is assigned and listed for your account. ```APIDOC ## GET /gateway/v1/esim/products/{product_id} ### Description Returns catalog detail when the SKU is assigned and listed for your account. ### Method GET ### Endpoint /gateway/v1/esim/products/{product_id} ### Parameters #### Path Parameters - **product_id** (string) - Required - Product id. #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "product_id": "string", "name": "string", "country_iso": "string", "duration": 0, "duration_unit": "string", "amount": 0, "amount_unit": "string", "is_unlimited": true, "unlimited_speed": "string", "networks": [ { "name": "string", "speed": "string", "country_iso": "string" } ], "imsi_profile": "string", "merchant_price": 0, "price_unit": "USD" } } ``` ``` -------------------------------- ### Get Card Info Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for a successful GET request to retrieve card information. It includes details about the card's status, balance, and associated holder information. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "card_id": "string", "card_name": "string", "mask_card_number": "41******1111", "card_currency": "string", "available_balance": 0, "brand_code": "VISA", "status": "PENDING", "card_type": "PHYSICAL", "accounting_type": "SHARE", "card_region": "US", "card_holder_id": "string", "first_name": "string", "last_name": "string", "mobile": { "nation_code": 86, "mobile": "string" }, "email": "string", "limit_per_day": 0, "limit_per_month": 0, "limit_per_transaction": 0, "bill_address": { "postcode": "string", "address": "string", "city": "string", "state": "string", "country": "string" }, "support_tds_trans": true, "create_time": "2024-04-02T13:03:12Z", "limit_modify_status": "PENDING", "limit_modify_request_id": "string" } } ``` -------------------------------- ### Add Payee Request Payload Example Source: https://api.gsalary.com/api Example JSON payload for adding a payee. Ensure all required fields are correctly populated according to the schema. ```json { "subject_type": "INDIVIDUAL", "account_type": "E_WALLET", "country": "string", "first_name": "string", "last_name": "string", "account_holder": "string", "currency": "USD" } ``` -------------------------------- ### Top-up Options for ICCID Response Sample Source: https://api.gsalary.com/api This JSON response sample details available top-up options for a given ICCID, including product information, pricing, and network details. It is returned by the GET /gateway/v1/esim/products/topups endpoint. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "iccid": "string", "esim_status": "PROVISIONED", "imsi_profile": "string", "products": [ { "product_id": "string", "name": "string", "country_iso": "string", "duration": 0, "duration_unit": "string", "amount": 0, "amount_unit": "string", "is_unlimited": true, "unlimited_speed": "string", "networks": [ { "name": "string", "speed": "string", "country_iso": "string" } ], "imsi_profile": "string", "merchant_price": 0, "price_unit": "USD" } ] } } ``` -------------------------------- ### Add Payee Response Sample (200 OK) Source: https://api.gsalary.com/api Example JSON response when a payee is successfully added (HTTP 200 OK). Includes result status and payee details. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "payee_id": "string", "subject_type": "INDIVIDUAL", "account_type": "E_WALLET", "first_name": "string", "last_name": "string", "country": "string", "account_holder": "string", "mobile": { "nation_code": 86, "mobile": "string" }, "address": "string" } } ``` -------------------------------- ### Product Details by ID Response Sample Source: https://api.gsalary.com/api This JSON response sample provides detailed information about a specific eSIM product when queried by its product ID. It is returned by the GET /gateway/v1/esim/products/{product_id} endpoint. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "product_id": "string", "name": "string", "country_iso": "string", "duration": 0, "duration_unit": "string", "amount": 0, "amount_unit": "string", "is_unlimited": true, "unlimited_speed": "string", "networks": [ { "name": "string", "speed": "string", "country_iso": "string" } ], "imsi_profile": "string", "merchant_price": 0, "price_unit": "USD" } } ``` -------------------------------- ### Get Card Secure Info Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for the Get Card Secure Info endpoint, containing sensitive card details. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "pan": "4111111111111111", "expire_year": "2025", "expire_month": "04", "cvv": "312" } } ``` -------------------------------- ### Card Available Quotas Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for the GET /cards/available_quotas endpoint, showing the structure for currency and quota information. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "query": { "currency": "string", "accounting_card_type": "string" }, "quota": { "currency": "USD", "amount": 0 } } } ``` -------------------------------- ### API Request Payload Example Source: https://api.gsalary.com/api This JSON object represents a sample request payload for an individual. Ensure all required fields are populated correctly. ```json { "subject_type": "INDIVIDUAL", "first_name": "string", "last_name": "string", "cert_type": "PASSPORT", "cert_number": "string", "birthday": "1991-06-22", "region": "CN", "company_name": "string", "register_number": "string", "cert_effective_date": "2000-01-01", "cert_expire_date": "2025-01-01", "email": "string", "mobile": { "nation_code": 86, "mobile": "string" }, "business_scopes": [ "MISCELLANEOUS_SERVICES" ] } ``` -------------------------------- ### API Endpoint for Querying Cards Source: https://api.gsalary.com/api This is the production and test endpoint for querying card information. No specific setup is required beyond making an HTTP GET request. ```HTTP https://api.gsalary.com/v1/cards https://api-test.gsalary.com/v1/cards ``` -------------------------------- ### Create Payment Session Response Sample (200 OK) Source: https://api.gsalary.com/api This is a sample successful response when creating a payment session. The 'data' object contains essential information like payment_session_data and a normal_url for initiating the client-side SDK. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "payment_session_data": "string", "payment_session_expiry_time": "2023-04-30T12:34:56Z", "payment_session_id": "string", "normal_url": "string" } } ``` -------------------------------- ### List Supported Countries/Regions and Currencies Response Sample Source: https://api.gsalary.com/api Sample JSON response for listing supported payout countries and currencies. It includes a list of countries, each with its associated supported currencies. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "countries": [ { "country": "string", "currencies": [ "USD" ] } ] } } ``` -------------------------------- ### Wallet Balance Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for a successful wallet balance query. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "currency": "string", "amount": 0, "share_card_account_balance": 0, "available": 0, "account_type": "BALANCE", "query_time": "string" } } ``` -------------------------------- ### Block ICCID API Request Example Source: https://api.gsalary.com/api This is an example of a successful response (200 OK) for blocking an ICCID. It includes details about the result and data, such as the ICCID status and a list of refunds. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "iccid": "string", "status": "string", "refunds": [ { "order_id": "string", "need_refund": true, "package_fee_refund": 0, "esim_card_fee_refund": 0, "total_refund": 0, "currency": "USD", "status": "string" } ] } } ``` -------------------------------- ### Get Payer Info Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for the 'Get Payer Info' endpoint. It provides detailed information about a specific payer, including personal, contact, and company details. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "payer_id": "string", "subject_type": "INDIVIDUAL", "first_name": "string", "last_name": "string", "cert_type": "PASSPORT", "cert_number": "string", "cert_files": [ "string" ], "birthday": "1991-06-22", "region": "CN", "company_name": "string", "register_number": "string", "cert_effective_date": "2000-01-01", "cert_expire_date": "2025-01-01", "email": "string", "mobile": { "nation_code": 86, "mobile": "string" }, "business_scopes": [ "MISCELLANEOUS_SERVICES" ], "address": { "postcode": "string", "address": "string", "city": "string", "state": "string", "country": "string" } } } ``` -------------------------------- ### Create TOPUP Order Source: https://api.gsalary.com/api Creates a TOPUP order for an existing profile. The `request_id` serves as the idempotency key. The target package is determined by `product_id` and `iccid`. ```APIDOC ## POST /gateway/v1/esim/orders/topup ### Description Renews an existing profile by creating a TOPUP order. The `request_id` is used for idempotency, and the `product_id` and `iccid` specify the target package. ### Method POST ### Endpoint /gateway/v1/esim/orders/topup ### Headers - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide. - **authorization** (string) - Required - Signature of request. Please check Integration Guide. ### Request Body #### Request Body schema: application/json - **product_id** (string) - Required - Product id. - **request_id** (string) - Required - Request id / idempotency key. A unique key to ensure the request is idempotent. - **iccid** (string) - Required - Target ICCID for the TOPUP. ### Request Example ```json { "product_id": "string", "request_id": "string", "iccid": "string" } ``` ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "order_id": "string", "operation_type": "NEW", "status": "PENDING", "create_time": "2019-08-24T14:15:22Z", "esim": { "iccid": "string", "imsi": "string", "msisdn": "string", "esim_qr": "string", "status": "PROVISIONED", "user_tag": "string", "apn": "string" }, "product": { "product_id": "string", "name": "string", "duration": 0, "duration_unit": "string", "imsi_profile": "string", "country_iso": "string" }, "subscription": { "status": "PENDING", "activation_time": "2019-08-24T14:15:22Z", "expiry": "2019-08-24T14:15:22Z", "termination_time": "2019-08-24T14:15:22Z", "activation_time_latest": "2019-08-24T14:15:22Z", "upper_limit_amount": 0, "used_amount": 0, "amount_unit": "string" }, "fee_detail": { "package_fee": 0, "esim_card_fee": 0, "total_charged": 0, "currency": "USD" } } } ``` ``` -------------------------------- ### Modify Payee Request Payload Source: https://api.gsalary.com/api Example JSON payload for modifying a payee. Ensure all required fields are included. ```json { "account_type": "E_WALLET", "country": "string", "first_name": "string", "last_name": "string", "account_holder": "string", "currency": "USD" } ``` -------------------------------- ### eSIM Product Catalog Response (200 OK) Source: https://api.gsalary.com/api This is a sample successful response (200 OK) for a query to the eSIM product catalog. It includes product details, pagination information, and pricing. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "products": [ { "product_id": "string", "name": "string", "country_iso": "string", "duration": 0, "duration_unit": "string", "amount": 0, "amount_unit": "string", "is_unlimited": true, "unlimited_speed": "string", "networks": [ { "name": "string", "speed": "string", "country_iso": "string" } ], "imsi_profile": "string", "merchant_price": 0, "price_unit": "USD" } ], "page": 0, "limit": 0, "total_count": 0, "total_page": 0 } } ``` -------------------------------- ### List Available Products Response Sample Source: https://api.gsalary.com/api This JSON structure represents a successful response when querying for available card products. It includes details about the query parameters used and a list of products with their respective attributes and limits. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "query": { "card_type": "string", "brand_code": "string", "currency": "string" }, "products": [ { "product_code": "string", "product_name": "string", "brand_code": "VISA", "currency": "USD", "stock": 0, "opened_quantity": 0, "card_type": "PHYSICAL", "accounting_card_type": "SHARE", "limit_per_transaction": 0, "limit_per_day": 0, "limit_per_month": 0, "support_tds_trans": true, "description": "string" } ] } } ``` -------------------------------- ### Get Device by ICCID Source: https://api.gsalary.com/api Retrieves the profile of an eSIM device using its ICCID. Requires App ID and Authorization headers. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "iccid": "string", "imsi": "string", "msisdn": "string", "esim_qr": "string", "status": "PROVISIONED", "user_tag": "string", "apn": "string" } } ``` -------------------------------- ### Apply Remittance Quote Source: https://api.gsalary.com/api This endpoint allows you to get a remittance quote. You need to provide details about the payee, payer, and the remittance itself. ```APIDOC ## Apply Remittance Quote ### Description This endpoint allows you to get a remittance quote. You need to provide details about the payee, payer, and the remittance itself. ### Method POST ### Endpoint /v1/remittance/quotes ### Headers - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Request Body - **payee_account_id** (string) - Required - Payee account id - **payer_id** (string) - Optional - Payer's ID. If left blank, GSalary will default to the current merchant entity as the payer. When the payment method is bank account, the payer must be an individual as well. - **purpose** (RemittancePurpose) - Optional - Enum: "SALARY" "FAMILY_SUPPORT" "CLOTHES_BAGS_SHOES" "DAILY_SUPPLIES_AND_COSMETICS" "ELECTRONICS_AND_HOME_APPLIANCES" "TOYS_KIDS_BABIES" "INTERPRETATION_SERVICE" "TRANSLATION_SERVICE" "HUMAN_RESOURCE_SERVICE" "ESTATE_AGENCY_SERVICE" "SOFTWARE_DEVELOPMENT_SERVICE" "WEB_DESIGN_OR_DEVELOPMENT_SERVICE" "DRAFTING_LEGAL_SERVICE" "LEGAL_RELATED_CERTIFICATION_SERVICE" "ACCOUNTING_SERVICE" "TAX_SERVICE" "ARCHITECTURAL_DECORATION_DESIGN_SERVICE" "ADVERTISING_SERVICE" "MARKET_RESEARCH_SERVICE" "EXHIBITION_BOOTH_SERVICE" "PRODUCT_PROMOTION_SERVICE" "ECOMMERCE_PROMOTION_SERVICE" "EDUCATION" "TRAVEL" "TRADE_PAYMENT" "SELF_SEND" "FREELANCER_PAYMENT" "GOODS_PAYMENT" "SERVICE_PAYMENT" Please check Remittance Purpose - **pay_currency** (string) - Required - Pay currency. Following ISO-4217 standard currency codes. - **receive_currency** (string) - Optional - Receive currency.(Since 1.7) Following ISO-4217 standard currency codes. Will use payee's currency as default. When payee configured more than 1 currencies, receive currency is required. If provided, the receive currency must be included in payee configured currencies. - **amount** (number) - Required - Remittance amount. Pay amount or receive amount which depends on amount type parameter. - **amount_type** (string) - Required - Remittance amount type. Enum Value: PAY_AMOUNT (The amount value is total pay out amount), RECEIVE_AMOUNT (The amount value is receipt amount. Receipt amount currency is determined when creating payee.) - **clearing_network** (string) - Optional - Such as SWIFT, ACH, etc. Required when payee account parameter `require_clearing_network` = `true`. Please referer to Available Clearing Network (Since 1.7) - **aba_number** (string) - Optional - ABA Code. Required when clearing network is ACH and FedWire.(Since 1.7) - **fps_bank_id** (string) - Optional - FPS Code. Required when clearing network is FPS.(Since 1.7) - **ifs_code** (string) - Optional - IFS Code. Required when bank of payee account is in India.(Since 1.7) - **intermediary_swift_code** (string) - Optional - Determine intermediary bank swift code when choosing SWIFT network.(Since 1.7) - **zengin_code** (string) - Optional - Zengin Code. Required when `clearing_network` = `LOCAL PAYMENT` and payee parameter `country` = `JP` and the payee’s receiving account has not maintained the zengin_code.(Since 1.32) - **remark** (string) - Optional - remark(Optional. If you submit remarks, you need to ensure that they contain only letters, numbers, and spaces, and are not more than 100 characters long.) ### Request Example ```json { "payee_account_id": "string", "payer_id": "string", "purpose": "SALARY", "pay_currency": "string", "receive_currency": "string", "amount": 0, "amount_type": "string", "clearing_network": "string", "aba_number": "string", "fps_bank_id": "string", "ifs_code": "string", "intermediary_swift_code": "string", "zengin_code": "string", "remark": "string" } ``` ### Response #### Success Response (200) - **result** (object) - Contains the status of the operation. - **result** (string) - Status code (e.g., "S" for success). - **code** (string) - Specific code for the result. - **message** (string) - Description of the result. - **data** (object) - Contains the remittance quote details. - **quote_id** (string) - Unique identifier for the quote. - **payment_method** (string) - The payment method used for the remittance. - **pay_amount** (object) - Details of the amount to be paid. - **currency** (string) - Currency of the pay amount. - **amount** (number) - The amount to be paid. - **receive_amount** (object) - Details of the amount to be received. - **currency** (string) - Currency of the receive amount. - **amount** (number) - The amount to be received. - **surcharge** (object) - Details of any surcharges. - **currency** (string) - Currency of the surcharge. - **amount** (number) - The surcharge amount. - **exchange_rate** (number) - The exchange rate for the remittance. - **expire_at** (string) - The expiration date and time of the quote. #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "quote_id": "string", "payment_method": "string", "pay_amount": { "currency": "USD", "amount": 0 }, "receive_amount": { "currency": "USD", "amount": 0 }, "surcharge": { "currency": "USD", "amount": 0 }, "exchange_rate": 0, "expire_at": "2024-06-07T11:23:22Z" } } ``` ``` -------------------------------- ### Successful eSIM Order Creation Response (200 OK) Source: https://api.gsalary.com/api This is a sample successful response for creating a new eSIM order. It includes details about the order, the eSIM, the product, subscription status, and fee breakdown. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "order_id": "string", "operation_type": "NEW", "status": "PENDING", "create_time": "2019-08-24T14:15:22Z", "esim": { "iccid": "string", "imsi": "string", "msisdn": "string", "esim_qr": "string", "status": "PROVISIONED", "user_tag": "string", "apn": "string" }, "product": { "product_id": "string", "name": "string", "duration": 0, "duration_unit": "string", "imsi_profile": "string", "country_iso": "string" }, "subscription": { "status": "PENDING", "activation_time": "2019-08-24T14:15:22Z", "expiry": "2019-08-24T14:15:22Z", "termination_time": "2019-08-24T14:15:22Z", "activation_time_latest": "2019-08-24T14:15:22Z", "upper_limit_amount": 0, "used_amount": 0, "amount_unit": "string" }, "fee_detail": { "package_fee": 0, "esim_card_fee": 0, "total_charged": 0, "currency": "USD" } } } ``` -------------------------------- ### Create Payee Account (E-Wallet) Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for the 'Create Payee Account (E-Wallet)' API endpoint upon successful creation. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "payment_method": "ALIPAY", "account_id": "string", "account_no": "string", "status": "PENDING", "currency": "string" } } ``` -------------------------------- ### Get Order Detail Source: https://api.gsalary.com/api Retrieves detailed information for a given order ID, including embedded device, product, subscription, and fee breakdown. ```APIDOC ## GET /v1/gateway/v1/esim/orders/{order_id} ### Description Order row with embedded device, product ref, subscription snapshot, and fee breakdown. ### Method GET ### Endpoint /v1/gateway/v1/esim/orders/{order_id} ### Parameters #### Path Parameters - **order_id** (string) - Required - GSalary eSIM order id (`order_id`; persisted `esim_orders.id`). #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "order_id": "string", "operation_type": "NEW", "status": "PENDING", "create_time": "2019-08-24T14:15:22Z", "esim": { "iccid": "string", "imsi": "string", "msisdn": "string", "esim_qr": "string", "status": "PROVISIONED", "user_tag": "string", "apn": "string" }, "product": { "product_id": "string", "name": "string", "duration": 0, "duration_unit": "string", "imsi_profile": "string", "country_iso": "string" }, "subscription": { "status": "PENDING", "activation_time": "2019-08-24T14:15:22Z", "expiry": "2019-08-24T14:15:22Z", "termination_time": "2019-08-24T14:15:22Z", "activation_time_latest": "2019-08-24T14:15:22Z", "upper_limit_amount": 0, "used_amount": 0, "amount_unit": "string" }, "fee_detail": { "package_fee": 0, "esim_card_fee": 0, "total_charged": 0, "currency": "USD" } } } ``` ``` -------------------------------- ### List Available Payment Methods API Response Sample Source: https://api.gsalary.com/api This is a sample JSON response for the 'List Available Payment Methods' API endpoint, showing available payment options. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "payment_methods": [ { "code": "ALIPAY", "country": "string", "currency": "string" } ] } } ``` -------------------------------- ### Get Card Holder Info Source: https://api.gsalary.com/api Retrieves information for a specific card holder using their ID. This endpoint requires authentication and an application ID. ```APIDOC ## Get Card Holder Info ### Description Retrieves detailed information about a card holder using their unique identifier. ### Method GET ### Endpoint /v1/card_holders/{card_holder_id} ### Parameters #### Path Parameters - **card_holder_id** (string) - Required - Card holder id from response of add card holder api. #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "card_holder_id": "string", "first_name": "string", "last_name": "string", "birth": "2001-12-20", "email": "string", "region": "string", "create_time": "2024-03-02T12:25:01Z", "bill_address": { "postcode": "string", "address": "string", "city": "string", "state": "string", "country": "string" }, "status": "PENDING", "security_index": "string", "security_question": "string", "security_answer": "string" } } ``` ``` -------------------------------- ### Get Card Secure Info Source: https://api.gsalary.com/api Retrieves secure information for a specific card, including PAN, expiry date, and CVV. Requires authentication headers. ```APIDOC ## Get Card Secure Info ### Description Retrieves secure information for a specific card, including PAN, expiry date, and CVV. Requires authentication headers. ### Method GET ### Endpoint /v1/cards/{card_id}/secure_info ### Parameters #### Path Parameters - **card_id** (string) - Required - Unique card id. Provided in card list or create card result. #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "pan": "4111111111111111", "expire_year": "2025", "expire_month": "04", "cvv": "312" } } ``` ``` -------------------------------- ### Create Payee Account (E-Wallet) Request Sample Source: https://api.gsalary.com/api This is a sample JSON payload for creating a payee account, specifically for an E-Wallet. Ensure the payment method and account details are correctly formatted. ```json { "payment_method": "ALIPAY", "account_no": "string" } ``` -------------------------------- ### Initiate Refund Source: https://api.gsalary.com/api Use this API to initiate a refund against a successful payment. The refund can be full or partial. A transaction can have multiple refunds as long as the total refund amount is less than or equal to the original transaction amount. If the refund request is out of the refund window determined in the contract, the refund request will be declined. ```APIDOC ## POST /acquiring/refund ### Description Use this API to initiate a refund against a successful payment. The refund can be full or partial. A transaction can have multiple refunds as long as the total refund amount is less than or equal to the original transaction amount. If the refund request is out of the refund window determined in the contract, the refund request will be declined. ### Method POST ### Endpoint https://api.gsalary.com/v1/acquiring/refund (Production) https://api-test.gsalary.com/v1/acquiring/refund (Test) ### Parameters #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide #### Request Body schema: application/json - **mch_app_id** (string) - Required - Merchant app id. After enabling acquirer services via your account manager, find your mch_app_id at: Merchant Portal > Configuration > My Products > Receive Payments - **refund_request_id** (string) - Required - The unique ID assigned by the merchant to identify a refund request - **payment_request_id** (string) - Required - The unique ID assigned by GSalary for the original payment to be refunded - **refund_currency** (string) - Required - The refund amount that is initiated by the merchant, The currency used for the corresponding payment of the refund. The value is a 3-letter currency code that follows the ISO 4217 standard - **refund_amount** (number) - Required - The refund amount that is initiated by the merchant, unit：yuan - **refund_reason** (string) - Optional - The refund reason ### Request Example ```json { "mch_app_id": "123456789", "refund_request_id": "R123456789", "payment_request_id": "PAY_987654321", "refund_currency": "USD", "refund_amount": 100, "refund_reason": "Product quality issues" } ``` ### Responses #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "refund_request_id": "string", "refund_id": "string", "payment_id": "string", "payment_request_id": "string", "refund_status": "PROCESSING", "refund_currency": "string", "refund_amount": 0, "refund_create_time": "string" } } ``` ``` -------------------------------- ### Get Card Available Quotas Source: https://api.gsalary.com/api Retrieves the available quota for cards, allowing users to check spending limits based on currency and accounting type. ```APIDOC ## GET /cards/available_quotas ### Description Retrieves the available quota for cards, allowing users to check spending limits based on currency and accounting type. ### Method GET ### Endpoint /v1/cards/available_quotas ### Parameters #### Query Parameters - **currency** (string) - Required - Card currency code. ISO-4217 currency codes (Supported currency: USD) - **accounting_card_type** (string) - Optional - Enum: "SHARE" "RECHARGE" - Card accounting type. Defaults to SHARE if not specified #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "query": { "currency": "string", "accounting_card_type": "string" }, "quota": { "currency": "USD", "amount": 0 } } } ``` ``` -------------------------------- ### Sample Response for 200 OK Source: https://api.gsalary.com/api This is a sample JSON response for a successful query of a new card application result. It includes the application status, processing code, and detailed data about the card and applicant. ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "request_id": "string", "status": "PENDING", "create_time": "string", "card_detail": { "card_id": "string", "card_name": "string", "mask_card_number": "41******1111", "card_currency": "string", "available_balance": 0, "brand_code": "VISA", "status": "PENDING", "card_type": "PHYSICAL", "accounting_type": "SHARE", "card_region": "US", "card_holder_id": "string", "first_name": "string", "last_name": "string", "mobile": { "nation_code": 86, "mobile": "string" }, "email": "string", "limit_per_day": 0, "limit_per_month": 0, "limit_per_transaction": 0, "bill_address": { "postcode": "string", "address": "string", "city": "string", "state": "string", "country": "string" }, "support_tds_trans": true, "create_time": "2024-04-02T13:03:12Z", "limit_modify_status": "PENDING", "limit_modify_request_id": "string" } } } ``` -------------------------------- ### Request Exchange Quote Payload Sample Source: https://api.gsalary.com/api This is a sample JSON payload for requesting an exchange quote. Specify buy/sell currencies and amounts to get a quote. ```json { "buy_currency": "HKD", "sell_currency": "USD", "buy_amount": 0, "sell_amount": 0 } ``` -------------------------------- ### Get Physical Card Activation Code Source: https://api.gsalary.com/api Retrieve the activation code for a physical card if the push notification was not received. It's recommended to prioritize webhook delivery. ```APIDOC ## Get Physical Card Activation Code ### Description Once the physical card is successfully allocated, you may query the activation code if the push notification isn’t received. We recommend prioritizing webhook delivery for retrieval and local storage. If the query returns empty (indicating the code is still being generated), please wait for the system push. ### Method GET ### Endpoint /cards/{card_id}/activation_code ### Parameters #### Path Parameters - **card_id** (string) - Required - Unique card id. Provided in card list or assign card result. #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK - **result.result** (string) - Indicates success or failure of the operation. - **result.code** (string) - A code associated with the operation result. - **result.message** (string) - A message describing the operation result. - **data.card_id** (string) - The unique identifier for the card. - **data.mask_card_number** (string) - The masked card number. - **data.activation_code** (string) - The activation code for the card. #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "card_id": "string", "mask_card_number": "string", "activation_code": "string" } } ``` ``` -------------------------------- ### Get Card Info Source: https://api.gsalary.com/api Retrieves detailed information about a specific card using its unique ID. This includes card status, balance, limits, and holder details. ```APIDOC ## Get Card Info ### Description Retrieves detailed information about a specific card using its unique ID. This includes card status, balance, limits, and holder details. ### Method GET ### Endpoint /v1/cards/{card_id} ### Parameters #### Path Parameters - **card_id** (string) - Required - Unique card id. Provided in card list or create card result. #### Header Parameters - **x-appid** (string) - Required - Appid from merchant portal. Please check Integration Guide - **authorization** (string) - Required - Signature of request. Please check Integration Guide ### Response #### Success Response (200) OK #### Response Example ```json { "result": { "result": "S", "code": "string", "message": "string" }, "data": { "card_id": "string", "card_name": "string", "mask_card_number": "41******1111", "card_currency": "string", "available_balance": 0, "brand_code": "VISA", "status": "PENDING", "card_type": "PHYSICAL", "accounting_type": "SHARE", "card_region": "US", "card_holder_id": "string", "first_name": "string", "last_name": "string", "mobile": { "nation_code": 86, "mobile": "string" }, "email": "string", "limit_per_day": 0, "limit_per_month": 0, "limit_per_transaction": 0, "bill_address": { "postcode": "string", "address": "string", "city": "string", "state": "string", "country": "string" }, "support_tds_trans": true, "create_time": "2024-04-02T13:03:12Z", "limit_modify_status": "PENDING", "limit_modify_request_id": "string" } } ``` ```