Skip to content

Latest commit

 

History

History
360 lines (304 loc) · 13.5 KB

PaymentMethod.md

File metadata and controls

360 lines (304 loc) · 13.5 KB
Raw

PaymentMethod

You can use the APIs below to interface with Xendit's PaymentMethod API. To start using the API, you need to destruct instantiated Xendit client or directly import the module and set the secret key.

import { Xendit, PaymentMethod as PaymentMethodClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { PaymentMethod } = xenditClient

const xenditPaymentMethodClient = new PaymentMethodClient({secretKey: YOUR_SECRET_KEY})

// At this point, `PaymentMethod` and `xenditPaymentMethodClient` will have no usage difference, for example:
// PaymentMethod.
// or
// xenditPaymentMethodClient.

All URIs are relative to https://api.xendit.co, except if the operation defines another base path.

Method HTTP request Description
createPaymentMethod() POST /v2/payment_methods Creates payment method
getPaymentMethodByID() GET /v2/payment_methods/{paymentMethodId} Get payment method by ID
getPaymentsByPaymentMethodId() GET /v2/payment_methods/{paymentMethodId}/payments Returns payments with matching PaymentMethodID.
patchPaymentMethod() PATCH /v2/payment_methods/{paymentMethodId} Patch payment methods
getAllPaymentMethods() GET /v2/payment_methods Get all payment methods by filters
expirePaymentMethod() POST /v2/payment_methods/{paymentMethodId}/expire Expires a payment method
authPaymentMethod() POST /v2/payment_methods/{paymentMethodId}/auth Validate a payment method's linking OTP
simulatePayment() POST /v2/payment_methods/{paymentMethodId}/payments/simulate Makes payment with matching PaymentMethodID.

createPaymentMethod() Function

Function Signature

Name Value
Function Name createPaymentMethod
Request Parameters CreatePaymentMethodRequest
Return Type PaymentMethod

Request Parameters - CreatePaymentMethodRequest

Field Name Type Required Default
forUserId string
data PaymentMethodParameters

Usage Example

Account linking for E-Wallet

import { PaymentMethodParameters, PaymentMethod } from 'xendit-node/payment_method/models'

const data: PaymentMethodParameters = {
  "ewallet" : {
    "channelProperties" : {
      "failureReturnUrl" : "https://redirect.me/failure",
      "successReturnUrl" : "https://redirect.me/success",
      "cancelReturnUrl" : "https://redirect.me/cancel"
    },
    "channelCode" : "OVO"
  },
  "metadata" : {
    "sku" : "example-1234"
  },
  "reusability" : "MULTIPLE_USE",
  "type" : "EWALLET",
  "customer" : {
    "type" : "INDIVIDUAL",
    "referenceId" : "customer-123",
    "individualDetail" : {
      "surname" : "Doe",
      "givenNames" : "John"
    }
  }
}

const response: PaymentMethod = await xenditPaymentMethodClient.createPaymentMethod({
    data
})

Account linking for PH Direct Debit

import { PaymentMethodParameters, PaymentMethod } from 'xendit-node/payment_method/models'

const data: PaymentMethodParameters = {
  "mobileNumber" : 628774494404,
  "reusability" : "MULTIPLE_USE",
  "type" : "DIRECT_DEBIT",
  "directDebit" : {
    "channelProperties" : {
      "failureReturnUrl" : "https://redirect.me/failure",
      "successReturnUrl" : "https://redirect.me/success"
    },
    "channelCode" : "BPI"
  },
  "email" : "testemail@email.com",
  "customer" : {
    "type" : "INDIVIDUAL",
    "referenceId" : "customer-123",
    "individualDetail" : {
      "surname" : "Doe",
      "givenNames" : "John"
    }
  }
}

const response: PaymentMethod = await xenditPaymentMethodClient.createPaymentMethod({
    data
})

getPaymentMethodByID() Function

Function Signature

Name Value
Function Name getPaymentMethodByID
Request Parameters GetPaymentMethodByIDRequest
Return Type PaymentMethod

Request Parameters - GetPaymentMethodByIDRequest

Field Name Type Required Default
paymentMethodId string ☑️
forUserId string

Usage Example

import { PaymentMethod } from 'xendit-node/payment_method/models'

const response: PaymentMethod = await xenditPaymentMethodClient.getPaymentMethodByID({ 
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)

getPaymentsByPaymentMethodId() Function

Function Signature

Name Value
Function Name getPaymentsByPaymentMethodId
Request Parameters GetPaymentsByPaymentMethodIdRequest
Return Type object

Request Parameters - GetPaymentsByPaymentMethodIdRequest

Field Name Type Required Default
paymentMethodId string ☑️
forUserId string
paymentRequestId string[]
paymentMethodId2 string[]
referenceId string[]
paymentMethodType PaymentMethodType[]
channelCode string[]
status string[]
currency string[]
createdGte Date
createdLte Date
updatedGte Date
updatedLte Date
limit number

Usage Example

const response: object = await xenditPaymentMethodClient.getPaymentsByPaymentMethodId({ 
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)

patchPaymentMethod() Function

Function Signature

Name Value
Function Name patchPaymentMethod
Request Parameters PatchPaymentMethodRequest
Return Type PaymentMethod

Request Parameters - PatchPaymentMethodRequest

Field Name Type Required Default
paymentMethodId string ☑️
forUserId string
data PaymentMethodUpdateParameters

Usage Example

import { PaymentMethod } from 'xendit-node/payment_method/models'

const response: PaymentMethod = await xenditPaymentMethodClient.patchPaymentMethod({ 
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)

getAllPaymentMethods() Function

Function Signature

Name Value
Function Name getAllPaymentMethods
Request Parameters GetAllPaymentMethodsRequest
Return Type PaymentMethodList

Request Parameters - GetAllPaymentMethodsRequest

Field Name Type Required Default
forUserId string
id string[]
type string[]
status PaymentMethodStatus[]
reusability PaymentMethodReusability
customerId string
referenceId string
afterId string
beforeId string
limit number

Usage Example

import { PaymentMethodList } from 'xendit-node/payment_method/models'

const response: PaymentMethodList = await xenditPaymentMethodClient.getAllPaymentMethods({ )

expirePaymentMethod() Function

Function Signature

Name Value
Function Name expirePaymentMethod
Request Parameters ExpirePaymentMethodRequest
Return Type PaymentMethod

Request Parameters - ExpirePaymentMethodRequest

Field Name Type Required Default
paymentMethodId string ☑️
forUserId string
data PaymentMethodExpireParameters

Usage Example

import { PaymentMethod } from 'xendit-node/payment_method/models'

const response: PaymentMethod = await xenditPaymentMethodClient.expirePaymentMethod({ 
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)

authPaymentMethod() Function

Function Signature

Name Value
Function Name authPaymentMethod
Request Parameters AuthPaymentMethodRequest
Return Type PaymentMethod

Request Parameters - AuthPaymentMethodRequest

Field Name Type Required Default
paymentMethodId string ☑️
forUserId string
data PaymentMethodAuthParameters

Usage Example

import { PaymentMethod } from 'xendit-node/payment_method/models'

const response: PaymentMethod = await xenditPaymentMethodClient.authPaymentMethod({ 
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)

simulatePayment() Function

Function Signature

Name Value
Function Name simulatePayment
Request Parameters SimulatePaymentOperationRequest
Return Type (void)

Request Parameters - SimulatePaymentOperationRequest

Field Name Type Required Default
paymentMethodId string ☑️
data SimulatePaymentRequest

Usage Example

const response = await xenditPaymentMethodClient.simulatePayment({ 
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822",
 })

Callback Objects

Use the following callback objects provided by Xendit to receive callbacks (also known as webhooks) that Xendit sends you on events, such as successful payments. Note that the example is meant to illustrate the contents of the callback object -- you will not need to instantiate these objects in practice

PaymentMethodCallback Object

Callback for active or expired E-Wallet or Direct Debit account linking, Virtual Accounts or QR strings

Model Documentation: PaymentMethodCallback

Usage Example

Note that the example is meant to illustrate the contents of the callback object -- you will not need to instantiate these objects in practice

import { PaymentMethodCallback } from 'xendit-node/payment_method/models'

const paymentMethodCallback = {
  "data" : {
    "country" : "PH",
    "metadata" : null,
    "failureCode" : null,
    "created" : "2022-08-12T13:30:26.579048Z",
    "description" : null,
    "reusability" : "MULTIPLE_USE",
    "type" : "DIRECT_DEBIT",
    "billingInformation" : null,
    "directDebit" : {
      "bankAccount" : {
        "maskedBankAccountNumber" : "XXXXXX1234",
        "bankAccountHash" : "b4dfa99c9b60c77f2e3962b73c098945"
      },
      "channelProperties" : {
        "failureReturnUrl" : "https://your-redirect-website.com/failure",
        "successReturnUrl" : "https://your-redirect-website.com/success"
      },
      "debitCard" : null,
      "type" : "BANK_ACCOUNT",
      "channelCode" : "BPI"
    },
    "referenceId" : "620b9df4-fe69-4bfd-b9d4-5cba6861db8a",
    "ewallet" : null,
    "directBankTransfer" : null,
    "qrCode" : null,
    "overTheCounter" : null,
    "customerId" : "e2878b4c-d57e-4a2c-922d-c0313c2800a3",
    "id" : "pm-6ff0b6f2-f5de-457f-b08f-bc98fbae485a",
    "updated" : "2022-08-12T13:30:58.908220358Z",
    "virtualAccount" : null,
    "card" : null,
    "status" : "ACTIVE"
  },
  "created" : "2022-08-12T13:30:59.074277334Z",
  "businessId" : "5f27a14a9bf05c73dd040bc8",
  "event" : "payment_method.activated"
}

You may then use the callback object in your webhook or callback handler like so,

function SimulatePaymentMethodCallback(paymentMethodCallback: PaymentMethodCallback) {
    const { id } = paymentMethodCallback
    // do things here with the callback
}

[Back to README]