Customer Object

{
  "customer": {
    "givenName": "Reforza Jordan",
    "sureName": "Geotama",
    "email": "reforza@pivot-payment.com",
    "phoneNumber": {
      "countryCode": "+62",
      "number": "89699990001"
    },
    "refundPreference": {
      "method": "AUTO",
      "transferDestination": {
        "channelCode": "014",
        "channelInformation": {
          "accountNumber": "17677665415",
          "accountName": "Reforza Jordan Geotama"
        }
      }
    },
    "storedPaymentMethods": [
      {
        "token": "bicbiweu63c",
        "paymentMethod": "ewallet",
        "paymentChannel": "dana",
        "createdAt": "2024-03-15T09:37:00Z",
        "status": "ACTIVE"
      },
      {
        "token": "bicewnbf3eu63c",
        "paymentMethod": "cards",
        "paymentChannel": "visa",
        "createdAt": "2024-06-15T09:37:00Z",
        "status": "ACTIVE"
      }
    ]
  }
}

Detail Customer Object

Parameter
Data Type
Requirement
Description

givenName

String

O

First name of the customer

sureName

String

O

Last name of the customer

email

String

M

Unique identifier of the customer

phoneNumber

Object

O

Phone number information

  • countryCode

String

M

Country code prefix (e.g., +62)

  • number

String

M

Phone number start with “8”

refundPreference

Object

O

Preferred refund method settings

  • method

String

M

Refund method preferred by Merchant / Customer, possible values:

  • AUTO (default) : Pivot will perform refund through Channel, if failed then fallback to Bank Transfer if available

  • TRANSFER_ONLY : Refund will be performed through Bank Transfer only, Merchant is required to send the destination account

  • transferDestination

Object

C

Required if method = TRANSFER_ONLY

>> channelCode

String

M

Channel code for payout destination such as Bank, E wallet or other channels

List of Channel code can be accessed here

>> channelInformation

Object

M

>>> accountNumber

String

M

Account Number of payout destination

>>> accountName

String

M

Account Name of payout destination from the Merchant

storedPaymentMethods

Array of Objects

O

List of tokenized payment methods stored under this customer profile *Shown on response only

  • token

String

M

Token ID representing the saved payment method *Shown on response only

  • paymentMethod

String

M

Type of payment method (e.g., ewallet, cards) *Shown on response only

  • paymentChannel

String

M

Payment provider (e.g., dana, visa) *Shown on response only

  • createdAt

String

M

Timestamp of when the token was created (ISO 8601 format) *Shown on response only

  • status

String

M

Token status, possible values:

  • ACTIVE

  • INACTIVE

*Shown on response only

Last updated