Skip to content

Data Products

Xendit Data Product APIs Pilot

June 2018

We're running a pilot of value-added data products to help you verify your customers’ identity and assess their risk. These pilots will be heavily rate limited tests for the next 2-4 weeks at 0 cost to get your feedback on the usefulness of this information as inputs to your business processes. In exchange for the free information, we'd like to hear your thoughts on:

  • If these products provide a useful signal to your account creation, lending or sales decision processes
  • How you'd integrate them with your process
    • Manually or automated
    • For unusual cases or for all cases
  • How many API calls you expect to use daily
  • What improvements can be made for them to be more valuable
  • What other data signals you'd like to see alongside them

Disbursement Volume API

We use our core position as a disbursement processor to aggregate payments flows by destination account. You can use the disbursement volume API to query a bank account to find the count and value of disbursements made to it within the last 28 days.

API Reference

URL: POST https://api.xendit.co/data/credit_risk/disbursement_volume

header:

  • Authorization: input your base 64 API key. Only use a live Production key. Development keys will return an INVALID_API_KEY error

body:

  • account number (string) : bank account number
  • bank code (string) : bank account number's bank code. Please only use bank code that is listed in https://xendit.github.io/apireference/#get-available-disbursement-banks

Response:

  • updated (ISO Date string) : the date (in UTC) when the data was last updated
  • account number (string) : bank account number
  • bank code (string) : bank account number's bank code
  • disbursement_amount (number) :The total amount of money disbursed to particular account number through Xendit
  • disbursement_count (number) : The total count of disbursements to particular account number through Xendit
  • time_in_day (number) : The time window for the disbursement data (i.e., number of days prior to the updated date)

Request Limit: 100 (daily, properly formed requests only)

Possible Error Codes: - REQUEST_LIMIT_REACHED_ERROR: You have made more than 100 properly formed requests and should try again in 24 hours - DESTINATION_ACCOUNT_NOT_AVAILABLE_ERROR: The account provided did not have any disbursements within the time window

Phone Number Validation API

We draw on a range of sources to return names associated with a phone number. If there are multiple names associated with a number across different sources, these will be returned as an array.

API Reference

URL : POST https://api.xendit.co/phone_number_data_requests

header:

  • Authorization : input your base 64 API key. Only use a live Production key. Development keys will return an INVALID_API_KEY error body: phone_number(string) : a valid indonesian phone number, including the leading 0 e.g., “085300000000”

Response:

  • updated (ISO Date string) : the date (in UTC) when the data was last updated
  • created (ISO Date string) : the date (in UTC) when the data was first created
  • status (string) : Status of the validation request
    • PENDING - The name validation request is still being processed. You may need to wait a minute between retries
    • SUCCESS - The name validation request has been completed
    • FAILED - The name validation request has failed. The most common reason for this will be that the number does not exist in any source that we use. In this case the failure reason will return "PHONE_NUMBER_NOT_FOUND_ERROR"
  • Phone_number_holder_names : an array of the unique names we have on record for this phone number