Pockyt

https://docs.pockyt.io
Admin
Pockyt provides a robust alternative payments infrastructure, enabling seamless integration with...
Tokens:188,016
Snippets:584
Trust Score:7.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### GBP Bank Account Example

Source: https://docs.pockyt.io/reference/payouts-add-payee-bank

This example demonstrates the structure for a GBP bank account, including account details, merchant information, and verification parameters. It requires specific fields like `accountCountry`, `accountCurrency`, `bankAccountId`, and `verifySign`.

```json
{
  "accountCountry": "GB",
  "accountCurrency": "GBP",
  "accountTag": "M2fxG7QK8RYbUI20j2Mc",
  "accountId": "00236554",
  "bankAccountId": "GB33BUKB20201555555555",
  "bankCode": "25565f5f44f",
  "bankAccountName": "Frank Monark",
  "bankId": "CITIGB2LCB2",
  "branchId": "321654",
  "accountType": "BANK_ACCOUNT",
  "bankAccountPurpose": "CHECKING",
  "customerNo": "2000376050410065858934",
  "ipnUrl": "https://example/webhook/listen",
  "merchantNo": "256987",
  "storeNo": "303587",
  "timestamp": "2025-01-23T17:06:05Z",
  "clientIp": "127.0.0.1",
  "verifySign": "a2ffb85366fcd084f5c471c44510c2b5"
}
```

--------------------------------

### Initiate Payout Request (Example Payload Structure)

Source: https://docs.pockyt.io/docs/payouts-to-chinese-bank-accounts

This example illustrates the structure of the request body required to initiate a payout. It includes essential parameters like accountToken, customerNo, amount, currency, and invoiceId, along with optional parameters for customization.

```json
{
  "customerNo": "YOUR_CUSTOMER_NUMBER",
  "accountToken": "YOUR_ACCOUNT_TOKEN",
  "amount": 100.50,
  "currency": "USD",
  "invoiceId": "unique-invoice-12345",
  "ipnUrl": "https://your.domain.com/webhook",
  "processingChannel": "DEFAULT",
  "memo": "Payout for services rendered"
}
```

--------------------------------

### Pockyt Hosted Page Payment Example

Source: https://docs.pockyt.io/reference/securepay-api

This example demonstrates the parameters for initiating a Pockyt Hosted Page payment. It includes essential details like merchant and store numbers, amount, currency, vendor, and callback URLs. Special characters are not supported in goodsInfo.

```json
{
  "merchantNo": "203780",
  "storeNo": "303661",
  "amount": "20.00",
  "currency": "USD",
  "settleCurrency": "USD",
  "vendor": "paypal",
  "terminal": "ONLINE",
  "timeout": "30",
  "reference": "8DtprlvpfA",
  "ipnUrl": "https://apis.gwocu.com/api/webhook/listen/HostedPayments?apiKey=1zlk90lhngw7hdh55wdfed5nysws45k5",
  "callbackUrl": "https://demo.pockyt.io/",
  "description": "Discounted store stuff",
  "note": "test note",
  "osType": "IOS",
  "goodsInfo": "[\"{\\\"goods_name\\\":\\\"test\\\",\\\"quantity\\\":\\\"1\\\",\\\"category\\\":\\\"DIGITAL_GOODS\\\",\\\"description\\\":\\\"testing\\\",\\\"amount\\\":\\\"10.00\\\",\\\"tax\\\":\\\"0\\\"},\\ \"{\\\"goods_name\\\":\\\"test 2\\\" ,\\\"quantity\\\":\\\"1\\\",\\\"category\\\":\\\"DIGITAL_GOODS\\\",\\\"description\\\":\\\"testing\\\",\\\"amount\\\":\\\"10.00\\\",\\\"tax\\\":\\\"0\\\"}]",
  "verifySign": "7f3284573d39da8ff183ae6c25dd3d37"
}
```

--------------------------------

### Pockyt InStore QR Code Payment Example

Source: https://docs.pockyt.io/reference/securepay-api

This example shows the parameters required for generating an InStore QR code for credit card payments. It specifies transaction details, merchant information, and URLs for handling payment notifications and callbacks. The vendor is set to 'creditcard'.

```json
{
  "amount": "100",
  "callbackUrl": "https://example.myweb-site.com/products",
  "currency": "USD",
  "description": "029e9b9b0b4e5cae68bf559b6333f466",
  "ipnUrl": "https://example.com/webhook/listener",
  "merchantNo": "202333",
  "note": "029e9b9b0b4e5cae68bf559b6333f466",
  "reference": "029e9b9b0b4e5cae68bf559b6333f466",
  "settleCurrency": "USD",
  "storeNo": "301854",
  "terminal": "YIP",
  "vendor": "creditcard",
  "verifySign": "ece4311b16c46435af3fb974ddbc2d43"
}

```

--------------------------------

### General Request Example

Source: https://docs.pockyt.io/reference/payouts-add-payee-bank

An example of a general request body that includes various fields for account and transaction processing.

```APIDOC
## General Request Example

### Description
This example demonstrates a request body with fields relevant for account creation or update, including identifying information and financial details.

### Method
N/A (Example only)

### Endpoint
N/A (Example only)

### Parameters
N/A

### Request Body
- **merchantNo** (string) - Required - Merchant identifier.
- **storeNo** (string) - Required - Store identifier.
- **timestamp** (string) - Required - Timestamp of the request in ISO 8601 format.
- **customerNo** (string) - Required - Customer identifier.
- **accountCountry** (string) - Required - Country code for the account.
- **bankCode** (string) - Required - Bank identification code.
- **cardNumber** (string) - Optional - Card number, if applicable.
- **governmentId** (string) - Required - Government-issued identification number.
- **governmentIdType** (string) - Required - Type of government identification.
- **accountCurrency** (string) - Required - Currency of the account.
- **accountType** (string) - Required - Type of account (e.g., BANK_ACCOUNT).
- **accountTag** (string) - Optional - Tag for the account.
- **bankAccountId** (string) - Required - Bank account identifier.
- **branchId** (string) - Optional - Branch identifier.
- **clientIp** (string) - Required - IP address of the client.
- **verifySign** (string) - Required - Signature for verification.

### Request Example
```json
{
  "merchantNo": "203780",
  "storeNo": "303661",
  "timestamp": "2025-02-05T21:56:23Z",
  "customerNo": "2000375967710229211730",
  "accountCountry": "CN",
  "bankCode": "01000000",
  "cardNumber": "876543219",
  "governmentId": "140421200101017700",
  "governmentIdType": "ID_CARD",
  "accountCurrency": "CNY",
  "accountType": "BANK_ACCOUNT",
  "accountTag": "PIoBDgUhROowJF6AaxXV",
  "bankAccountId": "123213412",
  "branchId": "12312321",
  "clientIp": "127.0.0.1",
  "verifySign": "d1b5f6f6bf8b2d350b4ebdb578aeaa0f"
}
```
```

--------------------------------

### Pockyt Recurring Payments Example

Source: https://docs.pockyt.io/reference/securepay-api

This example illustrates the parameters for setting up recurring payments using Pockyt. It includes customer-specific information, payment details, and references for managing recurring transactions. The creditType should be 'vault' for stored payment methods.

```json
{
  "amount": "13.00",
  "creditType": "vault",
  "currency": "USD",
  "customerNo": "2000357955353018248632",
  "callbackUrl": "https://demo.pockyt.io",
  "merchantNo": "203780",
  "reference": "gn8SQ3a5vU",
  "settleCurrency": "USD",
  "storeNo": "303661",
  "terminal": "YIP",
  "timeout": "120",
  "ipnUrl": "https://apis.gwocu.com/api/webhook/listen/RecurringPayments?apiKey=ihk4vdfnh9tdyuq11vreacne4ituhapf",
  "vendor": "paypal",
  "verifySign": "{{MySignature}}",
  "goodsInfo": "[\"{\\\"goods_name\\\":\\\"test\\\",\\\"quantity\\\":\\\"1\\\",\\\"category\\\":\\\"DIGITAL_GOODS\\\",\\\"description\\\":\\\"testing\\\",\\\"amount\\\":\\\"13.00\\\",\\\"tax\\\":\\\"0\\\"}]
}

```

--------------------------------

### Example mixedQuery API Response

Source: https://docs.pockyt.io/docs/merchant-presents-mixed-qrc

Demonstrates a successful response from the mixedQuery API, showing transaction details such as amount, currency, and the final recordStatus. The ret_code '000100' indicates a successful query.

```json
{
	"result": {
		"amount": "0.01",
		"createTime": "2025-12-12T11:15:08+08:00",
		"currency": "USD",
		"recordStatus": "paid",
		"saleAmount": "0.01",
		"settleCurrency": "USD",
		"tax": "0.00",
		"timeout": 5,
		"tip": 0,
		"transactionNo": "298291444591258733"
	},
	"ret_code": "000100",
	"ret_msg": "query success"
}
```

--------------------------------

### Chinese Bank Account Request Example

Source: https://docs.pockyt.io/reference/payouts-add-payee-bank

This example shows a request for a Chinese bank account, specifying merchant details, customer information, and government identification. It includes fields like `merchantNo`, `governmentId`, and `bankAccountId`.

```json
{
  "merchantNo": "203780",
  "storeNo": "303661",
  "timestamp": "2025-02-05T21:56:23Z",
  "customerNo": "2000375967710229211730",
  "accountCountry": "CN",
  "bankCode": "01000000",
  "cardNumber": "876543219",
  "governmentId": "140421200101017700",
  "governmentIdType": "ID_CARD",
  "accountCurrency": "CNY",
  "accountType": "BANK_ACCOUNT",
  "accountTag": "PIoBDgUhROowJF6AaxXV",
  "bankAccountId": "123213412",
  "branchId": "12312321",
  "clientIp": "127.0.0.1",
  "verifySign": "d1b5f6f6bf8b2d350b4ebdb578aeaa0f"
}
```

--------------------------------

### Bank Account Management

Source: https://docs.pockyt.io/reference/payouts-add-payee-bank

This section provides examples for various bank account configurations and data structures used within the Pockyt IO platform.

```APIDOC
## Bank Account Examples

### Description
Examples of bank account data for different countries and currencies, including request and response structures.

### Method
N/A (Examples only)

### Endpoint
N/A (Examples only)

### Parameters
N/A

### Request Example
#### US Bank Account Example
```json
{
  "bankAccountName": "Lewis Hamilton",
  "accountType": "BANK_ACCOUNT",
  "bankAccountPurpose": "CHECKING",
  "customerNo": "2000376041466816612048",
  "ipnUrl": "https://webhook.site/9ee5c170-6d5d-480d-940f-45ac50ee2587",
  "merchantNo": "203426",
  "storeNo": "302561",
  "timestamp": "2025-01-23T16:10:05Z",
  "clientIp": "127.0.0.1",
  "verifySign": "6fgh8dfha69t6ñdf28h7eb2s1fg7h"
}
```

#### GBP Bank Account Example
```json
{
  "accountCountry": "GB",
  "accountCurrency": "GBP",
  "accountTag": "M2fxG7QK8RYbUI20j2Mc",
  "accountId": "00236554",
  "bankAccountId": "GB33BUKB20201555555555",
  "bankCode": "25565f5f44f",
  "bankAccountName": "Frank Monark",
  "bankId": "CITIGB2LCB2",
  "branchId": "321654",
  "accountType": "BANK_ACCOUNT",
  "bankAccountPurpose": "CHECKING",
  "customerNo": "2000376050410065858934",
  "ipnUrl": "https://example/webhook/listen",
  "merchantNo": "256987",
  "storeNo": "303587",
  "timestamp": "2025-01-23T17:06:05Z",
  "clientIp": "127.0.0.1",
  "verifySign": "a2ffb85366fcd084f5c471c44510c2b5"
}
```

#### Colombian Bank Account Example
```json
{
  "accountCountry": "CO",
  "accountCurrency": "USD",
  "accountTag": "r6atQjERsbQy8n71BIJF",
  "bankAccountId": "2023161022892928374",
  "bankAccountName": "Lewis Hamilton",
  "accountType": "BANK_ACCOUNT",
  "bankId": "CAFECOBBXXX",
  "bankAccountPurpose": "CHECKING",
  "customerNo": "2000378291273409097720",
  "ipnUrl": "https://apis.example/webhooks/listener",
  "merchantNo": "203256",
  "storeNo": "302561",
  "timestamp": "2025-01-23T17:33:12Z",
  "clientIp": "127.0.0.1",
  "verifySign": "4fg5h8s95ha5dg6hsrth5dty5js4r"
}
```

### Response
#### Success Response (200)
```json
{
  "status": 200,
  "resultBody": {
    "result": {
      "accountTag": "uvQHIEMal7oeA1I53E38",
      "accountStatus": "ACTIVATED",
      "country": "CO",
      "lastName": "Landazury",
      "firstName": "Jorge",
      "accountType": "BANK_ACCOUNT",
      "currency": "USD",
      "accountToken": "2010378220058073164388",
      "customerNo": "2000378219817185509304",
      "email": "jorgecabon@gwocu.com",
      "timestamp": "2025-01-23T17:45:58Z",
      "status": "success"
    },
    "ret_msg": "success",
    "ret_code": "000100"
  }
}
```

#### Error Response Examples
##### VerifySign Error
```json
{
  "status": 200,
  "resultBody": {
    "ret_code": "000023",
    "ret_msg": "data error: verifySign"
  }
}
```

##### RoutingNumber Error
```json
{
  "status": 200,
  "resultBody": {
    "ret_code": "XXXXXX",
    "ret_msg": "Routing number error message"
  }
}
```
```

--------------------------------

### Delete Payee Funding Account Response Examples (JSON)

Source: https://docs.pockyt.io/reference/payouts-delete-payee-funding-account

These JSON examples illustrate successful and error responses from the 'Delete Payee Funding Account' endpoint. They cover cases for successful deletion, incorrect account tokens, invalid customer numbers, and timestamp errors, providing the `ret_code` and `ret_msg` for each scenario.

```json
{
    "ret_msg": "deleted",
    "ret_code": "000100"
}
```

```json
{
  "status": 200,
  "resultBody": {
    "ret_code": "000021",
    "ret_msg": "can not find related data by account"
  }
}
```

```json
{
  "status": 200,
  "resultBody": {
    "ret_msg": "no records",
    "ret_code": "000021"
  }
}
```

```json
{
  "status": 200,
  "resultBody": {
    "ret_code": "000023",
    "ret_msg": "data error: timestamp"
  }
}
```

--------------------------------

### POST /payee/account/configurations

Source: https://docs.pockyt.io/reference/international-transfer-methods

Retrieves configuration parameters for international transfer and crypto account payment methods. Examples are provided for both bank accounts and crypto wallets.

```APIDOC
## POST /payee/account/configurations

### Description
This endpoint is used to retrieve the configuration parameters for available payment methods in international transfers and crypto accounts. On the right-hand side, in the cURL section, you'll find examples showing how the request would look depending on whether you're using bank accounts or a crypto wallet.

### Method
POST

### Endpoint
/payee/account/configurations

### Parameters
#### Request Body
- **merchantNo** (string) - Required - Merchant ID in Pockyt's system. A unique value generated by Pockyt during the onboarding process.
- **storeNo** (string) - Required - Store Number in Pockyt's system. A unique value created and assigned by Pockyt's systems when a new store is created under a merchant.
- **timestamp** (string) - Required - Current UTC time, correct format should be "yyyy-mm-ddTHH:MM:SSZ".
- **verifySign** (string) - Required - The parameter signature. It is the calculated MD5 hash value of the API token used to encrypt the request message and authorize transaction requests. For more information, visit Signing API Parameters.
- **accountCountry** (string) - Optional - The bank account country (default: "US").
- **accountCurrency** (string) - Optional - The bank account currency (default: "USD").
- **accountType** (string) - Optional - The funding source account type (e.g., BANK_ACCOUNT) (default: "BANK_ACCOUNT").
- **profileType** (string) - Optional - The payee's profile type. Possible types are: INDIVIDUAL, BUSINESS (default: "INDIVIDUAL").

### Request Example
#### Bank accounts example
```json
{
  "merchantNo": "203780",
  "storeNo": "303661",
  "accountCountry": "US",
  "accountCurrency": "USD",
  "accountType": "BANK_ACCOUNT",
  "timestamp": "2025-01-24T15:39:25Z",
  "verifySign": "cac56b252c05fce25110165063e7c6cd"
}
```
#### Crypto Wallet Example
```json
{
  "accountCountry": "AU",
  "accountCurrency": "USDC",
  "merchantNo": "204298",
  "storeNo": "304420",
  "profileType": "INDIVIDUAL",
  "accountType": "CRYPTO",
  "timestamp": "2025-04-08T15:46:51Z",
  "verifySign": "58fd1f36f849218c79d93d20b3c273bb"
}
```

### Response
#### Success Response (200)
[Schema for success response not provided in the input]

#### Response Example
[Response example not provided in the input]
```

--------------------------------

### Get Bearer Token (OpenAPI Definition)

Source: https://docs.pockyt.io/reference/get-token

This OpenAPI 3.1.0 definition describes the 'Get Token' endpoint. It requires username and password for authentication and returns a bearer token upon successful authorization. It also includes examples for successful responses and common error scenarios like wrong credentials.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "merchant-onboarding-api",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://dash.yuansfer.com/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v1/oauth2/token": {
      "post": {
        "summary": "Get Token",
        "description": "This endpoint is used to get the bearer token used for authentication in the submit and query endpoints.",
        "operationId": "get-token",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "username",
                  "password"
                ],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Partner account username"
                  },
                  "password": {
                    "type": "string",
                    "description": "Partner account password"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": 200,\n  \"resultBody\": {\n    \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjgwMDM1NCIsImV4cGlyZXNBdCI6MTczOTUwMTEzMzYzM30.y8zY1kGvjVf_lIPE8adoqRsADJe2pCv5xdpMXMGEWSM\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 28799\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "resultBody": {
                      "type": "object",
                      "properties": {
                        "access_token": {
                          "type": "string",
                          "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjgwMDM1NCIsImV4cGlyZXNBdCI6MTczOTUwMTEzMzYzM30.y8zY1kGvjVf_lIPE8adoqRsADJe2pCv5xdpMXMGEWSM"
                        },
                        "token_type": {
                          "type": "string",
                          "example": "Bearer"
                        },
                        "expires_in": {
                          "type": "integer",
                          "example": 28799,
                          "default": 0
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "500",
            "content": {
              "application/json": {
                "examples": {
                  "Wrong credentials": {
                    "value": "{\n  \"status\": 500,\n  \"resultBody\": {\n    \"cause\": {\n      \"code\": \"UNABLE_TO_VERIFY_LEAF_SIGNATURE\"
    }
  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 500,
                      "default": 0
                    },
                    "resultBody": {
                      "type": "object",
                      "properties": {
                        "cause": {
                          "type": "object",
                          "properties": {
                            "code": {
                              "type": "string",
                              "example": "UNABLE_TO_VERIFY_LEAF_SIGNATURE"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

--------------------------------

### GET /websites/pockyt_io/accounts

Source: https://docs.pockyt.io/reference/international-transfer-methods

Retrieves a list of bank accounts associated with the Pockyt.io website. It includes details about the account type, currency, country, and required fields for setup.

```APIDOC
## GET /websites/pockyt_io/accounts

### Description
Retrieves a list of bank accounts associated with the Pockyt.io website. It includes details about the account type, currency, country, and required fields for setup.

### Method
GET

### Endpoint
/websites/pockyt_io/accounts

### Parameters

#### Query Parameters

#### Request Body

### Request Example

### Response
#### Success Response (200)
- **total** (integer) - The total number of accounts.
- **ret_msg** (string) - A message indicating the success of the operation.
- **results** (array) - An array of account objects.
  - **profileType** (string) - The type of profile (e.g., "INDIVIDUAL").
  - **accountType** (string) - The type of bank account (e.g., "BANK_ACCOUNT").
  - **accountCurrency** (string) - The currency of the account (e.g., "USD").
  - **accountCountry** (string) - The country of the account (e.g., "US").
  - **fields** (array) - An array of field objects required for account setup.
    - **isRequired** (boolean) - Indicates if the field is required.
    - **minLength** (integer) - The minimum length for the field value.
    - **name** (string) - The name of the field (e.g., "bankAccountId").
    - **label** (string) - The display label for the field (e.g., "Bank Account Number").
    - **maxLength** (integer) - The maximum length for the field value.
- **ret_code** (string) - The return code indicating the result of the operation.

#### Response Example
{
    "total": 1,
    "ret_msg": "succeeded",
    "results": [
        {
            "profileType": "INDIVIDUAL",
            "accountType": "BANK_ACCOUNT",
            "accountCurrency": "USD",
            "accountCountry": "US",
            "fields": [
                {
                    "isRequired": true,
                    "minLength": 0,
                    "name": "bankAccountId",
                    "label": "Bank Account Number",
                    "maxLength": 0
                },
                {
                    "isRequired": true,
                    "minLength": 0,
                    "name": "branchId",
                    "label": "Routing Number",
                    "maxLength": 0
                },
                {
                    "isRequired": true,
                    "minLength": 0,
                    "name": "bankAccountPurpose",
                    "label": "Type of bank account",
                    "maxLength": 0
                }
            ]
        }
    ],
    "ret_code": "000100"
}
```

--------------------------------

### Pockyt API Error: Payment Channel Configuration

Source: https://docs.pockyt.io/reference/securepay-api

This error signifies an issue with the payment channel configuration, likely due to an invalid vendor specified in the request. Contact Pockyt support for assistance with resolving payment channel setup problems. The example shows a success status with a specific error message for this configuration issue.

```json
{
  "status": 200,
  "resultBody": {
    "ret_code": "000000",
    "ret_msg": "Payment Channel Config Error, Please contact Pockyt."
  }
}
```

--------------------------------

### Merchant Onboarding API - Query Application

Source: https://docs.pockyt.io/docs/merchant-onboarding-api

Enables real-time status checks of submitted merchant applications using the merchant's email, partner ID, and referral code.

```APIDOC
## POST /api/merchant-onboarding/query

### Description
Queries the current status of a submitted merchant application.

### Method
POST

### Endpoint
`https://dash.yuansfer.com/api/merchant-onboarding/query`

### Parameters
#### Headers
- **authorization** (string) - Required - Bearer token retrieved from the Get Token step (e.g., `bearer <token>`)

#### Request Body
- **email** (string) - Required - The email used to register the merchant
- **partnerNo** (string) - Required - Partner ID assigned by Pockyt
- **referralCode** (string) - Required - Referral code associated with fee tables

### Request Example
```json
{
  "email": "merchant@example.com",
  "partnerNo": "PARTNER123",
  "referralCode": "REF456"
}
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the merchant application (e.g., 'PENDING', 'APPROVED', 'REJECTED').
- **applicationId** (string) - The unique identifier for the application.
- **data** (object) - Additional relevant data about the application, which may vary based on status.
```

--------------------------------

### Pockyt API Response Examples

Source: https://docs.pockyt.io/reference/create-qrc-api

Examples of Pockyt API responses illustrating successful operations and common error conditions such as signature verification failures or incorrect merchant credentials. These examples show the structure of the 'resultBody' including status codes and messages.

```json
{
  "status": 200,
  "resultBody": {
    "ret_code": "000023",
    "ret_msg": "data error: verifySign"
  }
}
```

```json
{
  "status": 200,
  "resultBody": {
    "ret_msg": "data error: merchantNo",
    "ret_code": "000000"
  }
}
```

--------------------------------

### POST /api/merchant-onboarding/submit

Source: https://docs.pockyt.io/reference/submit-merchant-application

Submits the merchant onboarding application with all required business and personal details.

```APIDOC
## POST /api/merchant-onboarding/submit

### Description
Submits the merchant onboarding application with all required business and personal details.

### Method
POST

### Endpoint
https://dash.yuansfer.com/api/merchant-onboarding/submit

### Parameters
#### Request Body
- **email** (string) - Required - The email address for the merchant.
- **partnerNo** (string) - Required - The partner number associated with the merchant.
- **referralCode** (string) - Required - The referral code for the merchant.
- **businessInfo** (object) - Required - Information about the business.
  - **legalName** (string) - Required - The legal name of the business.
  - **dbaName** (string) - Required - The Doing Business As name.
  - **country** (string) - Required - The country of the business.
  - **state** (string) - Required - The state of the business.
  - **city** (string) - Required - The city of the business.
  - **streetAddress** (string) - Required - The street address of the business.
  - **zipCode** (string) - Required - The zip code of the business.
  - **contactNumber** (string) - Required - The contact phone number for the business.
  - **website** (string) - Required - The website URL of the business.
- **profileInfo** (object) - Required - Information about the merchant's profile.
  - **ownership** (string) - Required - The ownership type of the business.
  - **taxId** (string) - Required - The tax identification number.
  - **registrationDate** (string) - Required - The date the business was registered (YYYY-MM-DD).
  - **description** (string) - Required - A description of the business.
  - **averageVolume** (string) - Required - The average transaction volume.
  - **monthlyVolume** (string) - Required - The estimated monthly transaction volume.
- **representativeInfo** (object) - Required - Information about the primary representative.
  - **representativeName** (string) - Required - The first name of the representative.
  - **representativeLastName** (string) - Required - The last name of the representative.
  - **representativeContactNumber** (string) - Required - The contact phone number for the representative.
  - **representativeCountry** (string) - Required - The country of the representative.
  - **representativeState** (string) - Required - The state of the representative.
  - **representativeCity** (string) - Required - The city of the representative.
  - **representativeStreetAddress** (string) - Required - The street address of the representative.
  - **representativeZipCode** (string) - Required - The zip code of the representative.
  - **representativeIssueCountry** (string) - Required - The country where the representative's government ID was issued.
  - **representativeGovernmentIdType** (string) - Required - The type of government ID (e.g., Passport, Driver's License).
  - **representativeGovernmentId** (string) - Required - The representative's government ID number.
  - **representativeIssueDate** (string) - Required - The issue date of the representative's government ID (YYYY-MM-DD).
  - **representativeIssueExpireDate** (string) - Required - The expiration date of the representative's government ID (YYYY-MM-DD).
- **ownerInfos** (array) - Required - An array of objects, each containing information about an owner.
  - **ownerName** (string) - Required - The first name of the owner.
  - **ownerLastName** (string) - Required - The last name of the owner.
  - **ownerPercent** (string) - Required - The percentage of ownership.
  - **ownerBirthDate** (string) - Required - The owner's birth date (YYYY-MM-DD).
  - **ownerContactNumber** (string) - Required - The owner's contact phone number.
  - **ownerCountry** (string) - Required - The owner's country.
  - **ownerStreetAddress** (string) - Required - The owner's street address.
  - **ownerCity** (string) - Required - The owner's city.
  - **ownerState** (string) - Required - The owner's state.
  - **ownerZipCode** (string) - Required - The owner's zip code.
  - **ownerCitizenShip** (string) - Required - The owner's citizenship.
  - **ownerGovernmentIdType** (string) - Required - The type of government ID.
  - **ownerGovernmentId** (string) - Required - The owner's government ID number.
- **bankInfo** (object) - Required - Information about the business bank account.
  - **bankName** (string) - Required - The name of the bank.
  - **accountNumber** (string) - Required - The bank account number.
  - **routingNumber** (string) - Required - The bank routing number.
  - **wireRouting** (string) - Optional - The wire routing number.
  - **bankBranchName** (string) - Optional - The name of the bank branch.
  - **bankAddress** (string) - Optional - The address of the bank.

### Request Example
```json
{
  "email": "test20231215023@ff.com",
  "partnerNo": "800001",
  "referralCode": "test20231120001301",
  "businessInfo": {
    "legalName": "test2023121501",
    "dbaName": "test2023121501",
    "country": "US",
    "state": "New York",
    "city": "New York",
    "streetAddress": "testStreet",
    "zipCode": "123032",
    "contactNumber": "23423424",
    "website": "https://osfdoji.com"
  },
  "profileInfo": {
    "ownership": "1",
    "taxId": "4234234",
    "registrationDate": "1988-04-20",
    "description": "asodjfoasdifjergjeorgtetsfadfasfdasdf",
    "averageVolume": "100",
    "monthlyVolume": "500000"
  },
  "representativeInfo": {
    "representativeName": "eoirgjeorg",
    "representativeLastName": "osjdfoi last name",
    "representativeContactNumber": "234234",
    "representativeCountry": "US",
    "representativeState": "New York",
    "representativeCity": "New York",
    "representativeStreetAddress": "fsoiafjo street",
    "representativeZipCode": "433453",
    "representativeIssueCountry": "US",
    "representativeGovernmentIdType": "Passport",
    "representativeGovernmentId": "345345345",
    "representativeIssueDate": "1988-05-03",
    "representativeIssueExpireDate": "2024-06-05"
  },
  "ownerInfos": [
    {
      "ownerName": "gerregerg",
      "ownerLastName": "3gerogjio",
      "ownerPercent": "55",
      "ownerBirthDate": "1988-04-30",
      "ownerContactNumber": "345345345",
      "ownerCountry": "US",
      "ownerStreetAddress": "34r3gjeorgoj",
      "ownerCity": "New York",
      "ownerState": "New York",
      "ownerZipCode": "34345",
      "ownerCitizenShip": "US",
      "ownerGovernmentIdType": "Passport",
      "ownerGovernmentId": "34534t345"
    },
    {
      "ownerName": "gergerg",
      "ownerLastName": "rthrhtyjnty",
      "ownerPercent": "35",
      "ownerBirthDate": "1988-05-30",
      "ownerContactNumber": "3565345345",
      "ownerCountry": "US",
      "ownerStreetAddress": "fergerg",
      "ownerCity": "New York",
      "ownerState": "New York",
      "ownerZipCode": "343545",
      "ownerCitizenShip": "US",
      "ownerGovernmentIdType": "Passport",
      "ownerGovernmentId": "45456456"
    }
  ],
  "bankInfo": {
    "bankName": "fwojef bank",
    "accountNumber": "25345345345",
    "routingNumber": "4304349",
    "wireRouting": "3240304953",
    "bankBranchName": "2342342",
    "bankAddress": "3434534"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the submission (e.g., "000100" for success).
- **ret_msg** (string) - A message indicating the result of the submission (e.g., "submit success").

#### Response Example
```json
{
  "status": "000100",
  "ret_msg": "submit success"
}
```

#### Error Response (400)
An empty JSON object `{}` is returned for a 400 error.
```

--------------------------------

### Merchant Onboarding API - Submit Application

Source: https://docs.pockyt.io/docs/merchant-onboarding-api

Allows partners to submit comprehensive merchant data for review and onboarding. Requires a bearer token obtained from the 'Get Token' endpoint.

```APIDOC
## POST /api/merchant-onboarding/submit

### Description
Submits detailed merchant application data for onboarding and internal review.

### Method
POST

### Endpoint
`https://dash.yuansfer.com/api/merchant-onboarding/submit`

### Parameters
#### Headers
- **authorization** (string) - Required - Bearer token retrieved from the Get Token step (e.g., `bearer <token>`)

#### Request Body
- **email** (string) - Required - Merchant's email address
- **legalName** (string) - Required - Legal name of the merchant business
- **dbaName** (string) - Optional - Doing Business As name
- **country** (string) - Required - Merchant's country code
- **state** (string) - Required - Merchant's state code
- **representativeName** (string) - Required - First name of the merchant representative
- **representativeLastName** (string) - Required - Last name of the merchant representative
- **representativeGovernmentId** (string) - Required - Government ID of the merchant representative
- **ownerName** (string) - Required - Name of the business owner
- **ownerPercent** (number) - Required - Percentage of ownership
- **ownerGovernmentId** (string) - Required - Government ID of the business owner
- **bankName** (string) - Required - Name of the merchant's bank
- **accountNumber** (string) - Required - Merchant's bank account number
- **routingNumber** (string) - Required - Merchant's bank routing number

### Request Example
```json
{
  "email": "merchant@example.com",
  "legalName": "Merchant Legal Name",
  "dbaName": "Merchant DBA",
  "country": "US",
  "state": "CA",
  "representativeName": "John",
  "representativeLastName": "Doe",
  "representativeGovernmentId": "123456789",
  "ownerName": "Jane Smith",
  "ownerPercent": 100,
  "ownerGovernmentId": "987654321",
  "bankName": "Example Bank",
  "accountNumber": "1234567890",
  "routingNumber": "021000021"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the application was submitted successfully.
- **applicationId** (string) - Unique identifier for the submitted application.
```

--------------------------------

### POST /api/v1/oauth2/token

Source: https://docs.pockyt.io/reference/get-token

This endpoint is used to get the bearer token used for authentication in the submit and query endpoints.

```APIDOC
## POST /api/v1/oauth2/token

### Description
This endpoint is used to get the bearer token required for authenticating requests to the submit and query endpoints.

### Method
POST

### Endpoint
/api/v1/oauth2/token

### Parameters
#### Request Body
- **username** (string) - Required - Partner account username
- **password** (string) - Required - Partner account password

### Request Example
```json
{
  "username": "your_username",
  "password": "your_password"
}
```

### Response
#### Success Response (200)
- **status** (integer) - The status code of the response.
- **resultBody** (object) - Contains the authentication token details.
  - **access_token** (string) - The generated bearer token.
  - **token_type** (string) - The type of token, typically 'Bearer'.
  - **expires_in** (integer) - The time in seconds until the token expires.

#### Response Example (Success)
```json
{
  "status": 200,
  "resultBody": {
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjgwMDM1NCIsImV4cGlyZXNBdCI6MTczOTUwMTEzMzYzM30.y8zY1kGvjVf_lIPE8adoqRsADJe2pCv5xdpMXMGEWSM",
    "token_type": "Bearer",
    "expires_in": 28799
  }
}
```

#### Error Response (500)
- **status** (integer) - The status code of the error response.
- **resultBody** (object) - Contains details about the error.
  - **cause** (object) - Information about the cause of the error.
    - **code** (string) - A specific error code indicating the issue (e.g., "UNABLE_TO_VERIFY_LEAF_SIGNATURE").

#### Response Example (Error)
```json
{
  "status": 500,
  "resultBody": {
    "cause": {
      "code": "UNABLE_TO_VERIFY_LEAF_SIGNATURE"
    }
  }
}
```
```

--------------------------------

### Customer Data Example (JSON)

Source: https://docs.pockyt.io/reference/register-customer

This JSON object represents a sample customer's information, including personal details, contact information, and account identifiers. It is used as an input for customer-related API operations.

```json
{
  "zip": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "customerCode": "CUST123",
  "email": "john.doe@example.com",
  "country": "US",
  "city": "New York",
  "dateOfBirth": "1990-01-01",
  "phone": "555-123-4567",
  "countryCode": "1",
  "street": "123 Main St",
  "street2": "Apt 4B",
  "state": "NY",
  "lang": "en",
  "profileType": "individual",
  "merchantNo": "MERCHANT123",
  "storeNo": "STORE123",
  "verifysign": "signature",
  "company": "Example Company",
  "mobileNumber": "555-987-6543"
}
```
Tokens:
Raw