---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/tokenization/oneClickPayment/bind/index.md
description: >-
  The binding interface is used to tokenize and store user's bank card
  information, supporting subsequent quick payments. It is suitable for
  scenarios such as e-commerce platforms and mobile applications, improving
  payment security and convenience. Main functions include generating and
  managing card tokens, with key parameters including merchant ID, user ID, and
  card information.
---
# Binding Interface

```apidef
endpoint: POST /v4/paymethod/bind
name: Binding Interface
summary: Get an APM agreement token
variant: APM
tags: Tokenization, APM
```

The binding interface is used to tokenize and store user's bank card information, supporting subsequent quick payments. It is suitable for scenarios such as e-commerce platforms and mobile applications, improving payment security and convenience. Main functions include generating and managing card tokens, with key parameters including merchant ID, user ID, and card information.

## Request Parameters

| Parameter | Type | Required | Description |
|--------|------|------|------|
| accId | string | M | Unique identifier for the store, which will appear in the response message after creation; inputting it means modifying the data |
| clientId | string | M | PingPong Merchant ID |
| signType | string | M | Supports MD5 , SHA256; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document |
| sign | string | M | Signature; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document. All parameters participate in the signature |
| version | string | M | Version number, currently fixed at 1.0, may be adjusted with changes to the interface in the future |
| bizContent | string | M | Collection of request parameters, with no limit on maximum length. Except for common request parameters, all other request parameters must be passed within this parameter, format: JSON string |
| └─ requestId | string | M | Unique Request Number |
| └─ merchantUserId | string | M | Member ID, the user's member ID on the merchant's website |
| └─ paymentMethod | object | M | Payment Method |
| └─ └─ type | string | M | Supported payment methods enumeration: Boost; GCash; TNG eWallet; DANA; Kakaopay; True Money; AlipayHK; Alipay; Rabbit LINE Pay; |
| └─ merchantResultUrl | string | M | Merchant Result Page Address |
| └─ notificationUrl | string | M | Merchant notification address.
URL recommendation: use a complete URL with a publicly reachable domain name. Standard web ports are recommended (HTTPS defaults to 443 and HTTP defaults to 80). Ensure the URL can reliably receive PingPongCheckout asynchronous notifications. |
| └─ device | object | M | Device Parameters |
| └─ └─ orderTerminal | string | O | 01-H5; 02-PC; 04-iOS; 05-ANDROID; |
| └─ bizType | string | M | Fixed Value: CodeGrant |

### Request Example

```json
{
  "accId": "2022102018024210348883",
  "bizContent": "{\"merchantUserId\":\"126048964333251315123\",\"requestId\":\"PMT-SM2NG9AEOV1716798866107\",\"merchantResultUrl\":\"https://test-acquirerpay.pingpongx.com/qa/result.html\",\"notificationUrl\":\"https://test-acquirerpay.pingpongx.com/qa/result.html\",\"bizType\":\"CodeGrant\",\"paymentMethod\":{\"type\":\"Alipay\"},\"device\":{\"orderTerminal\":\"02\"}}",
  "clientId": "2022102018024210348",
  "sign": "29DEE85CCEFE3C9BCE870BE5D3573B76EA89997287A07BBAC7599621A00719C1",
  "signType": "SHA256",
  "version": "1.0"
}
```

## Response Parameters

| Parameter | Type | Description |
|--------|------|------|
| sign | string | Signature Value |
| bizContent | string | Business Parameters |
| └─ token | string | Token |
| └─ authUrl | string | Contract Link |
| signType | string | Signature Method |
| code | string | Result Status Code |
| description | string | Result Description |

### Response Example

```json
{
  "bizContent": "{\"token\":\"196876a82e5bfb40f1fee402fec92f52\",\"authUrl\":\"https://g.alipayplus.com/page/aplus-linker/acwallet/authorization.html?scopes=AGREEMENT_PAY%2CUSER_LOGIN_ID&bizContent=%7B%22acquirerId%22%3A%22Z02TE5520000000A%22%2C%22authClientDisplayName%22%3A%22BL%20Company%22%2C%22authClientId%22%3A%222022102018024210348%22%2C%22authClientName%22%3A%22BL%20Company%22%2C%22authRedirectUrl%22%3A%22https%3A%2F%2Fg.alipayplus.com%2Fpage%2Fac-auth-payment%2Fresult%2Fmobile%2Findex.html%3FloadMode%3D2%26callbackType%3DCommon%26terminalType%3DWEB%26referenceAgreementId%3D1716444968758634%26authRequestId%3D2024052319091305000190000395242%26pspId%3DT56264108532298562A%26clientId%3DSANDBOX_5Y60882YJZ2405725%22%2C%22authState%22%3A%221716444968758634%22%2C%22customerBelongsTo%22%3A%22BOOST%22%2C%22pspId%22%3A%22T56264108532298562A%22%2C%22referenceAgreementId%22%3A%221716444968758634%22%2C%22referenceMerchantId%22%3A%222022102018024210348%22%2C%22scopes%22%3A%5B%22AGREEMENT_PAY%22%2C%22USER_LOGIN_ID%22%5D%2C%22terminalType%22%3A%22WEB%22%7D&source=AlipayConnect&needCallback=true\"}",
  "sign": "102897C8BF0AA4B9C2D78CE20800FD2E2288856CF1C76A18BC985954A4B36390",
  "signType": "SHA256"
}
```