Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Query Individual

Retrieves the current profile and onboarding status of an individual merchant.

Endpoint

POST /remittance/merchant/query-individual

Sandbox base URL: https://rem-api-sandbox.pagsmile.com Content-Type: application/json; charset=UTF-8

The request uses the standard Remittance API request envelope. The fields below describe the decrypted biz_data object.

Requirement: M = Mandatory, O = Optional, and C = Conditional. A conditional field is mandatory only when the condition stated in its description applies.

Encrypt biz_data, encrypt the AES key into random_key, and sign the request according to the Common request specification.

Request body

Decrypted biz_data fields

Field
Type
Requirement
Description

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant on whose behalf the request is submitted.

id_no

string(6-20)

M

Number of the identity document.

id_type

integer

M

Type of identity document used for identity verification. See Type of certificate. for supported values.

Choose one of field holder_id and field (id_no,id_type).

Plaintext biz_data example

This example includes mandatory fields and representative optional or conditional fields. Submit fields marked C only when the condition in the field description applies.

{
  "merchant_id": 100398,
  "id_no": "AB123456789",
  "id_type": 1
}

Request example

Use the partner_id and app_id assigned to your integration. The values above are placeholders.

Response

Response data fields

Field
Type
Requirement
Description

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant associated with the returned individual merchant profile.

status

integer

M

Current status of the record. Supported values: 0 — Initial 1 — Enabled 2 — Disabled

mobile

string

M

Full mobile phone number, including the international country calling code.

first_name

string

M

Legal first name of the individual.

last_name

string

M

Legal last name of the individual.

id_no

string

M

Number of the identity document.

id_type

integer

M

Type of identity document used for identity verification. See ID Type for supported values.

issuance_date

string

O

Issue date of the identity document. Format: yyyy-MM-dd.

expires_on

string

O

Expiration date of the identity document. Format: yyyy-MM-dd.

email

string

M

Email address of the merchant or contact person.

birthday

string

M

Date of birth of the individual. Format: yyyy-MM-dd.

gender

integer

M

Gender of the individual merchant. See Gender for supported values.

nationality_code

string

M

Two-letter ISO 3166-1 alpha-2 code representing the individual's nationality.

address.address_id

long

M

Unique identifier of the address.

address.line

string

M

First line of the individual's residential address. Format: CHARSETS_4.

address.line2

string

O

Optional second line of the individual's residential address. Format: CHARSETS_4.

address.postal_code

string

M

ZIP or postal code of the individual's residential address.

address.city_name

string

M

City of the individual's residential address. Format: CHARSETS_6.

address.state

string

M

State, province, or region of the individual's residential address. Format: CHARSETS_6.

address.country_code

string

M

Two-letter ISO 3166-1 alpha-2 country code of the individual's residential address.

created_at

string

O

Date and time when the individual merchant profile was created. Format: yyyy-MM-dd HH:mm:ss.

Related APIs

Last updated

Was this helpful?