Create a deposit order

Collection method categories and return value description of the collection order interface

Collection method categories	Return value description
Bank VA category Bank VA	payData: Bank's VA number, merchants need to build their own payment details page payUrl: TarsPay's VA payment details page
E-wallet category Ewallet	OVO payData: TarsPay's OVO fills in the mobile phone number to push the bill payment details page payUrl: TarsPay's OVO fills in the mobile phone number to push the bill payment details page DANA and LINKAJA payData: Official native jump link (wake up APP) payUrl: Official jump link (wake up APP)
QR code QRIS	payData: QR code image, merchants need to build their own payment details page payUrl: TarsPay's QRIS payment details page

Note:

The specific return value of each collection method varies according to actual business needs.

Please make sure to correctly configure the payData and payUrl fields in actual use.

payData builds the payment details page for the merchant itself. The core data of the payment uses the value returned by the interface. The payUrl is the payment details page that the merchant has not paid, but uses TarsPay's payment details page.

Collection method code:

Bank type code

Bank code	Bank name
BANK_BCA	BANK BCA
BANK_BNI	BANK BNI
BANK_BRI	BANK BRI
BANK_BSI	BANK BSI
BANK_CIMB	BANK CIMB
BANK_MANDIRI	BANK MANDIRI
BANK_DANAMON	BANK DANAMON
BANK_PERMATA	BANK PERMATA

Wallet type code

E-wallet code	E-wallet name
EWALLET_DANA	EWALLET DANA
EWALLET_LINKAJA	EWALLET LINKAJA
EWALLET_OVO	EWALLET OVO
EWALLET_SHOPEEPAY	EWALLET SHOPEEPAY

Convenience store (mart) type code

Convenience store code	Convenience store name
MART_ALFA	MART ALFA
MART_INDO	MART INDO

Scan code (qris) type code

Scan code code	Scan code name
QRIS	QRIS

Limit information

	Collection amount rules
Collection channel	Minimum single transaction	Maximum single transaction
BANK	10,000	50,000,000
EWALLET	10,000	10,000,000
QIRS	10,000	10,000,000
MART-Debit Card	10,000	5,000,000
MART-Cash	10,000	2,500,000

Request

Header Params

Body Params application/json

Example

{
    "amount": "string",
    "body": "string",
    "currency": "string",
    "customerAccountNumber": "string",
    "customerContact": "string",
    "customerEmail": "string",
    "customerName": "string",
    "mchNo": "string",
    "mchOrderNo": "string",
    "notifyUrl": "string",
    "returnUrl": "string",
    "subject": "string",
    "wayCode": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Bodyapplication/json

Examples

Bank VA Success ExamplesE-wallet success examplesQRIS Success Examples

{
    "code": 0,
    "data": {
        "amount": "30000",
        "body": "Test",
        "countryCode": "id",
        "currency": "IDR",
        "customerContact": "123445555",
        "expiredTime": 1702287455,
        "mchOrderNo": "YN45620230300675",
        "orderState": 1,
        "payData": "706675107919",
        "payDataType": "payurl",
        "payOrderId": "P1734130292633829377",
        "payUrl": "https://payment.tpservice.ai/#/order/id/P1734130292633829377",
        "payWays": {
            "bank": [
                {
                    "countryCode": "id",
                    "createdAt": 0,
                    "id": 1,
                    "payCode": "706675107919",
                    "payWay": "BANK_PERMATA",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/589e70d4-6bc7-447a-97bd-b59b4b752d37.png",
                    "payWayType": "bank",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        },
        "requestUrl": "https://www.tarspay.com/notify/return",
        "subject": "buycar"
    },
    "msg": "SUCCESS",
    "sign": "304502203601332548ddfad0c75bb47bb2188ffe4c209270eb13fba14555c51bf0b0cae5022100ce4f7aae639a313b5b716d0490ef281987efe4c6c8c75c1515b3418a32e4174a"
}

Create a deposit order

Collection method categories and return value description of the collection order interface#

Note:#

Collection method code:#

Bank type code#

Wallet type code#

Convenience store (mart) type code#

Scan code (qris) type code#

Limit information#