Security News
MCP Community Begins Work on Official MCP Metaregistry
The MCP community is launching an official registry to standardize AI tool discovery and let agents dynamically find and install MCP servers.
By Sarah Gooding - May 09, 2025
🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
xendit
Xendit REST API Client for Python - Card, Virtual Account, Invoice, Disbursement, Recurring Payments, Payout, EWallet, Balance, Retail Outlets Services https://xendit.github.io/apireference/
- Maintainers
- 1
Xendit Python Library
This library is the abstraction of Xendit API for access from applications written with Python.
Table of Contents
- Xendit Python Library
- Table of Contents
- API Documentation
- Requirements
- Installation
- Usage
- API Key
- Headers
- Object Creation
- Balance Service
- Credit Card
- eWallets
- Direct Debit
- Create Customer
- Get Customer by Reference ID
- Initialize Linked Account Tokenization
- Validate OTP for Linked Account Token
- Retrieve Accessible Accounts by Linked Account Token
- Create Payment Method
- Get Payment Methods by Customer ID
- Create Direct Debit Payment
- Create Recurring Payment with Direct Debit
- Validate OTP for Direct Debit Payment
- Get Direct Debit Payment Status by ID
- Get Direct Debit Payment Status by Reference ID
- Virtual Account Service
- Retail Outlet Service
- Invoice Service
- Recurring Payment
- Disbursement Service
- Contributing
API Documentation
Please check Xendit API Reference.
Requirements
Python 3.7 or later
Installation
To use the package, run pip install xendit-python
Usage
API Key
To add API Key, you have 2 option: Use global variable or use Xendit instance
Global Variable
import xendit
xendit.api_key = "test-key123"
# Then just run each class as static
from xendit import Balance
Balance.get()
Use Xendit Instance
import xendit
x = xendit.Xendit(api_key="test-key123")
# Then access each class from x attribute
Balance = x.Balance
Balance.get()
Headers
You can add headers by using the following keyword parameters
- X-IDEMPOTENCY-KEY:
x_idempotency_key
VirtualAccount.create(x_idempotency_key="your-idemp-key")
- for-user-id:
for_user_id
Balance.get(for_user_id='subaccount-user-id')
- X-API-VERSION:
x_api_version
Balance.get(x_api_version='2020-01-01')
Object Creation
If an API need an object as its parameter, you can use either dictionary for that class or a helper method e.g:
items = []
item = {
id: "123123",
name: "Phone Case",
price: 100000,
quantity: 1
}
items.append(item)
EWallet.create_linkaja_payment(
external_id="linkaja-ewallet-test-1593663498",
phone="089911111111",
items=items,
amount=300000,
callback_url="https://my-shop.com/callbacks",
redirect_url="https://xendit.co/",
)
is equivalent with
items = []
item = xendit.EWallet.helper_create_linkaja_item(
id="123123", name="Phone Case", price=100000, quantity=1
)
items.append(item)
EWallet.create_linkaja_payment(
external_id="linkaja-ewallet-test-1593663498",
phone="089911111111",
items=items,
amount=300000,
callback_url="https://my-shop.com/callbacks",
redirect_url="https://xendit.co/",
)
Balance Service
Get Balance
The account_type parameter is optional.
from xendit import Balance
Balance.get()
Balance.AccountType(
account_type=BalanceAccountType.CASH,
)
Usage example:
from xendit import Balance, BalanceAccountType
Balance balance = Balance.get(
account_type=BalanceAccountType.CASH,
)
# To get the JSON view
print(balance)
# To get only the value
print(balance.balance)
Will return
{'balance': 1000000000}
1000000000
Credit Card
Create Authorization
from xendit import CreditCard
charge = CreditCard.create_authorization(
token_id="5f0410898bcf7a001a00879d",
external_id="card_preAuth-1594106356",
amount=75000,
card_cvn="123",
)
print(charge)
Will return
{
"status": "AUTHORIZED",
"authorized_amount": 75000,
"capture_amount": 0,
"currency": "IDR",
"business_id": "5ed75086a883856178afc12e",
"merchant_id": "xendit_ctv_agg",
"merchant_reference_code": "5f0421faa98815a4f4c92a0d",
"external_id": "card_preAuth-1594106356",
"eci": "07",
"charge_type": "MULTIPLE_USE_TOKEN",
"masked_card_number": "400000XXXXXX0002",
"card_brand": "VISA",
"card_type": "CREDIT",
"descriptor": "XENDIT*XENDIT'S INTERN",
"bank_reconciliation_id": "5941063625146828103011",
"approval_code": "831000",
"created": "2020-07-07T07:19:22.921Z",
"id": "5f0421fa8cc1e8001973a1d6"
}
Reverse Authorization
from xendit import CreditCard
reverse_authorization = CreditCard.reverse_authorizatiton(
credit_card_charge_id="5f0421fa8cc1e8001973a1d6",
external_id="reverse-authorization-1594106387",
)
print(reverse_authorization)
Will return
{
"status": "SUCCEEDED",
"currency": "IDR",
"credit_card_charge_id": "5f0421fa8cc1e8001973a1d6",
"business_id": "5ed75086a883856178afc12e",
"external_id": "card_preAuth-1594106356",
"amount": 75000,
"created": "2020-07-07T07:19:48.896Z",
"id": "5f0422148cc1e8001973a1dc"
}
Create Charge
from xendit import CreditCard
charge = CreditCard.create_charge(
token_id="5f0410898bcf7a001a00879d",
external_id="card_charge-1594106478",
amount=75000,
card_cvn="123",
)
print(charge)
Will return
{
"status": "CAPTURED",
"authorized_amount": 75000,
"capture_amount": 75000,
"currency": "IDR",
"business_id": "5ed75086a883856178afc12e",
"merchant_id": "xendit_ctv_agg",
"merchant_reference_code": "5f0422746fc1d25bd222df2e",
"external_id": "card_charge-1594106478",
"eci": "07",
"charge_type": "MULTIPLE_USE_TOKEN",
"masked_card_number": "400000XXXXXX0002",
"card_brand": "VISA",
"card_type": "CREDIT",
"descriptor": "XENDIT*XENDIT'S INTERN",
"bank_reconciliation_id": "5941064846646923303008",
"approval_code": "831000",
"created": "2020-07-07T07:21:25.027Z",
"id": "5f0422752bbbe50019a368b5"
}
Capture Charge
from xendit import CreditCard
charge = CreditCard.capture_charge(
credit_card_charge_id="5f0422aa2bbbe50019a368c2",
amount=75000,
)
print(charge)
Will return
{
"status": "CAPTURED",
"authorized_amount": 75000,
"capture_amount": 75000,
"currency": "IDR",
"created": "2020-07-07T07:22:18.719Z",
"business_id": "5ed75086a883856178afc12e",
"merchant_id": "xendit_ctv_agg",
"merchant_reference_code": "5f0422aa6fc1d25bd222df32",
"external_id": "card_preAuth-1594106532",
"eci": "07",
"charge_type": "MULTIPLE_USE_TOKEN",
"masked_card_number": "400000XXXXXX0002",
"card_brand": "VISA",
"card_type": "CREDIT",
"descriptor": "XENDIT*XENDIT'S INTERN",
"bank_reconciliation_id": "5941065383296525603007",
"approval_code": "831000",
"mid_label": "CTV_TEST",
"id": "5f0422aa2bbbe50019a368c2"
}
Get Charge
from xendit import CreditCard
charge = CreditCard.get_charge(
credit_card_charge_id="5f0422aa2bbbe50019a368c2",
)
print(charge)
Will return
{
"status": "CAPTURED",
"authorized_amount": 75000,
"capture_amount": 75000,
"currency": "IDR",
"created": "2020-07-07T07:22:18.719Z",
"business_id": "5ed75086a883856178afc12e",
"merchant_id": "xendit_ctv_agg",
"merchant_reference_code": "5f0422aa6fc1d25bd222df32",
"external_id": "card_preAuth-1594106532",
"eci": "07",
"charge_type": "MULTIPLE_USE_TOKEN",
"masked_card_number": "400000XXXXXX0002",
"card_brand": "VISA",
"card_type": "CREDIT",
"descriptor": "XENDIT*XENDIT'S INTERN",
"bank_reconciliation_id": "5941065383296525603007",
"approval_code": "831000",
"mid_label": "CTV_TEST",
"metadata": {},
"id": "5f0422aa2bbbe50019a368c2"
}
Create Refund
from xendit import CreditCard
refund = CreditCard.create_refund(
credit_card_charge_id="5f0422aa2bbbe50019a368c2",
amount=10000,
external_id="card_refund-1594106755",
)
print(refund)
Will return
{
"status": "REQUESTED",
"currency": "IDR",
"credit_card_charge_id": "5f0422aa2bbbe50019a368c2",
"user_id": "5ed75086a883856178afc12e",
"amount": 10000,
"external_id": "card_refund-1594106755",
"created": "2020-07-07T07:25:56.872Z",
"updated": "2020-07-07T07:25:57.740Z",
"id": "5f0423848bb8da600c57c44f",
"fee_refund_amount": 290
}
Create Promotion
from xendit import CreditCard
promotion = CreditCard.create_promotion(
reference_id="BRI_20_JAN-1594176600",
description="20% discount applied for all BRI cards",
discount_amount=10000,
bin_list=['400000', '460000'],
start_time="2020-01-01T00:00:00.000Z",
end_time="2021-01-01T00:00:00.000Z",
)
print(promotion)
Will return
{
"business_id": "5ed75086a883856178afc12e",
"reference_id": "BRI_20_JAN-1594176600",
"description": "20% discount applied for all BRI cards",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2021-01-01T00:00:00.000Z",
"type": "CARD_BIN",
"discount_amount": 10000,
"bin_list": [
"400000",
"460000"
],
"currency": "IDR",
"id": "c65a2ae7-ce75-4a15-bbec-55d076f46bd0",
"created": "2020-07-08T02:50:02.296Z",
"status": "ACTIVE"
}
eWallets
Create OVO Payment
from xendit import EWallet
ovo_payment = EWallet.create_ovo_payment(
external_id="ovo-ewallet-testing-id-1593663430",
amount="80001",
phone="08123123123",
)
print(ovo_payment)
Will return
{
"amount": 80001,
"business_id": "5ed75086a883856178afc12e",
"external_id": "ovo-ewallet-testing-id-1593663430",
"ewallet_type": "OVO",
"phone": "08123123123",
"created": "2020-07-02T04:17:12.979Z",
"status": "PENDING"
}
Create DANA Payment
from xendit import EWallet
dana_payment = EWallet.create_dana_payment(
external_id="dana-ewallet-test-1593663447",
amount="1001",
callback_url="https://my-shop.com/callbacks",
redirect_url="https://my-shop.com/home",
)
print(dana_payment)
Will return
{
"external_id": "dana-ewallet-test-1593663447",
"amount": 1001,
"checkout_url": "https://sandbox.m.dana.id/m/portal/cashier/checkout?bizNo=20200702111212800110166820100550620×tamp=1593663450389&mid=216620000000261692328&sign=XS3FMKj1oZHkTWu0EXk8PBwzjR1VtwSedqbKX%2BgMF6CyZvbA5xhAmMUR%2FlhD4QkBODbbTPcju1YDFnHmSdzmjbqPfGcQGtkCPgLwVOZo1ERPmoUhhGJIbQXkfZ1Z8eA1w1RSqDzdmDB%2B%2FlvHaTbYPiUlvjzs%2BfgkM33YFFEl0BG1kUFz0%2FKb9OoT1QKyoHxw6ge4SWPF3Po6BwNtjqUZe2n43s7y0CvSrcNiNLHT3k2XHSlIdguwCGjNHh2zClgtv9XbSCecnD96nuIuohYARX8Ai%2BaYo%2FEDO1VEch4XditfIXvyBhL0TocxhYxda7yKNNjkZj56Rl9ds8u7Wyv1eQ%3D%3D",
"ewallet_type": "DANA"
}
Create LinkAja Payment
from xendit import EWallet, LinkAjaItem
items = []
items.append(LinkAjaItem(id="123123", name="Phone Case", price=100000, quantity=1))
linkaja_payment = EWallet.create_linkaja_payment(
external_id="linkaja-ewallet-test-1593663498",
phone="089911111111",
items=items,
amount=300000,
callback_url="https://my-shop.com/callbacks",
redirect_url="https://xendit.co/",
)
print(linkaja_payment)
Will return
{
"checkout_url": "https://ewallet-linkaja-dev.xendit.co/checkouts/c627cf1f-0470-420f-a0f4-3931ef384bf4",
"transaction_date": "2020-07-02T04:18:21.729Z",
"amount": 300000,
"external_id": "linkaja-ewallet-test-1593663498",
"ewallet_type": "LINKAJA"
}
Get Payment Status
from xendit import EWallet
ovo_payment_status = EWallet.get_payment_status(
ewallet_type=EWalletType.OVO,
external_id="ovo-ewallet-testing-id-1234",
)
print(ovo_payment_status)
Will return
{
"amount": "8888",
"business_id": "5ed75086a883856178afc12e",
"ewallet_type": "OVO",
"external_id": "ovo-ewallet-testing-id-1234",
"status": "COMPLETED",
"transaction_date": "2020-06-30T01:32:28.267Z"
}
Direct Debit
Create Customer
from xendit import DirectDebit
customer = DirectDebit.create_customer(
reference_id="merc-1594279037",
email="t@x.co",
given_names="Adyaksa",
)
print(customer)
Will return
{
"id": "ed20b5db-df04-41fc-8018-8ea4ac4d1030",
"reference_id": "merc-1594279037",
"description": null,
"given_names": "Adyaksa",
"middle_name": null,
"surname": null,
"mobile_number": null,
"phone_number": null,
"email": "t@x.co",
"nationality": null,
"addresses": null,
"date_of_birth": null,
"employment": null,
"source_of_wealth": null,
"metadata": null
}
Get Customer by Reference ID
from xendit import DirectDebit
customer = DirectDebit.get_customer_by_ref_id(
reference_id="merc-1594279037",
)
print(customer)
Will return
[{
"id": "ed20b5db-df04-41fc-8018-8ea4ac4d1030",
"reference_id": "merc-1594279037",
"description": null,
"given_names": "Adyaksa",
"middle_name": null,
"surname": null,
"mobile_number": null,
"phone_number": null,
"email": "t@x.co",
"nationality": null,
"addresses": null,
"date_of_birth": null,
"employment": null,
"source_of_wealth": null,
"metadata": null
}]
Initialize Linked Account Tokenization
from xendit import DirectDebit
card_linking = DirectDebit.helper_create_card_link(
account_mobile_number="+62818555988",
card_last_four="8888",
card_expiry="06/24",
account_email="test.email@xendit.co",
)
linked_account = DirectDebit.initialize_tokenization(
customer_id="ed20b5db-df04-41fc-8018-8ea4ac4d1030",
channel_code="DC_BRI",
properties=card_linking,
)
print(linked_account)
Will return
{
"id": "lat-f325b757-0aae-4c24-92c5-3661e299e154",
"customer_id": "ed20b5db-df04-41fc-8018-8ea4ac4d1030",
"channel_code": "DC_BRI",
"authorizer_url": null,
"status": "PENDING",
"metadata": null
}
Validate OTP for Linked Account Token
from xendit import DirectDebit
linked_account = DirectDebit.validate_token_otp(
linked_account_token_id="lat-f325b757-0aae-4c24-92c5-3661e299e154",
otp_code="333000",
)
print(linked_account)
Will return
{
"id": "lat-f325b757-0aae-4c24-92c5-3661e299e154",
"customer_id": "ed20b5db-df04-41fc-8018-8ea4ac4d1030",
"channel_code": "DC_BRI",
"status": "SUCCESS",
"metadata": null
}
Retrieve Accessible Accounts by Linked Account Token
from xendit import DirectDebit
accessible_accounts = DirectDebit.get_accessible_account_by_token(
linked_account_token_id="lat-f325b757-0aae-4c24-92c5-3661e299e154",
)
print(accessible_accounts)
Will return
[{
"channel_code": "DC_BRI",
"id": "la-08b089e8-7035-4f5f-bdd9-94edd9dc9480",
"properties": {
"card_expiry": "06/24",
"card_last_four": "8888",
"currency": "IDR",
"description": ""
},
"type": "DEBIT_CARD"
}]
Create Payment Method
from xendit import DirectDebit
payment_method = DirectDebit.create_payment_method(
customer_id="ed20b5db-df04-41fc-8018-8ea4ac4d1030",
type=DirectDebitPaymentMethodType.DEBIT_CARD,
properties={'id': 'la-fac7e744-ab40-4100-a447-cbbb16f29ded'},
)
print(payment_method)
Will return
{
"customer_id": "ed20b5db-df04-41fc-8018-8ea4ac4d1030",
"type": "DEBIT_CARD",
"properties": {
"id": "la-fac7e744-ab40-4100-a447-cbbb16f29ded",
"currency": "IDR",
"card_expiry": "06/24",
"description": "",
"channel_code": "DC_BRI",
"card_last_four": "8888"
},
"status": "ACTIVE",
"metadata": {},
"id": "pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
"created": "2020-07-13T07:28:57.716Z",
"updated": "2020-07-13T07:28:57.716Z"
}
Get Payment Methods by Customer ID
from xendit import DirectDebit
payment_methods = DirectDebit.get_payment_methods_by_customer_id(
customer_id="ed20b5db-df04-41fc-8018-8ea4ac4d1030",
)
print(payment_methods)
Will return
[{
"id": "pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
"customer_id": "ed20b5db-df04-41fc-8018-8ea4ac4d1030",
"status": "ACTIVE",
"type": "DEBIT_CARD",
"properties": {
"id": "la-fac7e744-ab40-4100-a447-cbbb16f29ded",
"currency": "IDR",
"card_expiry": "06/24",
"description": "",
"channel_code": "DC_BRI",
"card_last_four": "8888"
},
"metadata": {},
"created": "2020-07-13T07:28:57.716Z",
"updated": "2020-07-13T07:28:57.716Z"
}]
Create Direct Debit Payment
from xendit import DirectDebit
payment = DirectDebit.create_payment(
reference_id="direct-debit-ref-1594718940",
payment_method_id="pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
currency="IDR",
amount="60000",
callback_url="http://webhook.site/",
enable_otp=True,
idempotency_key="idemp_key-1594718940",
)
print(payment)
Will return
{
"failure_code": null,
"otp_mobile_number": null,
"otp_expiration_timestamp": null,
"id": "ddpy-eaa093b6-b669-401a-ba2e-61ac644b2aff",
"reference_id": "direct-debit-ref-1594718940",
"payment_method_id": "pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
"channel_code": "DC_BRI",
"currency": "IDR",
"amount": 60000,
"is_otp_required": true,
"basket": null,
"description": "",
"status": "PENDING",
"metadata": null,
"created": "2020-07-14T09:29:02.614443Z",
"updated": "2020-07-14T09:29:02.614443Z"
}
Create Recurring Payment with Direct Debit
You can use Create Recurring Payment to use this feature.
Validate OTP for Direct Debit Payment
from xendit import DirectDebit
payment = DirectDebit.validate_payment_otp(
direct_debit_id="ddpy-eaa093b6-b669-401a-ba2e-61ac644b2aff",
otp_code="222000",
)
print(payment)
Will return
{
"failure_code": null,
"otp_mobile_number": null,
"otp_expiration_timestamp": null,
"id": "ddpy-eaa093b6-b669-401a-ba2e-61ac644b2aff",
"reference_id": "direct-debit-ref-1594718940",
"payment_method_id": "pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
"channel_code": "DC_BRI",
"currency": "IDR",
"amount": 60000,
"is_otp_required": true,
"basket": null,
"description": "",
"status": "PENDING",
"metadata": null,
"created": "2020-07-14T09:29:02.614443Z",
"updated": "2020-07-14T09:29:02.614443Z"
}
Get Direct Debit Payment Status by ID
from xendit import DirectDebit
payment = DirectDebit.get_payment_status(
direct_debit_id="ddpy-38ef50a8-00f0-4019-8b28-9bca81f2cbf1",
)
print(payment)
Will return
{
"failure_code": null,
"otp_mobile_number": null,
"otp_expiration_timestamp": null,
"id": "ddpy-38ef50a8-00f0-4019-8b28-9bca81f2cbf1",
"reference_id": "direct-debit-ref-1594717458",
"payment_method_id": "pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
"channel_code": "DC_BRI",
"currency": "IDR",
"amount": 60000,
"is_otp_required": false,
"basket": null,
"description": "",
"status": "PENDING",
"metadata": null,
"created": "2020-07-14T09:04:20.031451Z",
"updated": "2020-07-14T09:04:20.031451Z"
}
Get Direct Debit Payment Status by Reference ID
from xendit import DirectDebit
payments = DirectDebit.get_payment_status_by_ref_id(
reference_id="direct-debit-ref-1594717458",
)
print(payments)
Will return
[{
"amount": 60000,
"basket": null,
"channel_code": "DC_BRI",
"created": "2020-07-14T09:04:20.031451Z",
"currency": "IDR",
"description": "",
"failure_code": null,
"id": "ddpy-38ef50a8-00f0-4019-8b28-9bca81f2cbf1",
"is_otp_required": false,
"metadata": null,
"otp_expiration_timestamp": null,
"otp_mobile_number": null,
"payment_method_id": "pm-b6116aea-8c23-42d0-a1e6-33227b52fccd",
"reference_id": "direct-debit-ref-1594717458",
"status": "PENDING",
"updated": "2020-07-14T09:04:20.031451Z"
}]
Virtual Account Service
Create Virtual Account
from xendit import VirtualAccount
virtual_account = VirtualAccount.create(
external_id="demo_1475459775872",
bank_code="BNI",
name="Rika Sutanto",
)
print(virtual_account)
Will return
{
"owner_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"bank_code": "BNI",
"merchant_code": "8808",
"name": "Rika Sutanto",
"account_number": "8808999956275653",
"is_single_use": false,
"status": "PENDING",
"expiration_date": "2051-06-22T17:00:00.000Z",
"is_closed": false,
"id": "5ef174c48dd9ea2fc97d6a1e"
}
Get Virtual Account Banks
from xendit import VirtualAccount
virtual_account_banks = VirtualAccount.get_banks()
print(virtual_account_banks)
Will return
[{
"name": "Bank Mandiri",
"code": "MANDIRI"
}, {
"name": "Bank Negara Indonesia",
"code": "BNI"
}, {
"name": "Bank Rakyat Indonesia",
"code": "BRI"
}, {
"name": "Bank Permata",
"code": "PERMATA"
}, {
"name": "Bank Central Asia",
"code": "BCA"
}]
Get Virtual Account
from xendit import VirtualAccount
virtual_account = VirtualAccount.get(
id="5eec3a3e8dd9ea2fc97d6728",
)
print(virtual_account)
Will return
{
"owner_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"bank_code": "BNI",
"merchant_code": "8808",
"name": "Rika Sutanto",
"account_number": "8808999917965673",
"is_single_use": true,
"status": "ACTIVE",
"expiration_date": "2051-06-18T17:00:00.000Z",
"is_closed": false,
"id": "5eec3a3e8dd9ea2fc97d6728"
}
Update Virtual Account
from xendit import VirtualAccount
virtual_account = VirtualAccount.update(
id="5eec3a3e8dd9ea2fc97d6728",
is_single_use=True,
)
print(virtual_account)
Will return
{
"owner_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"bank_code": "BNI",
"merchant_code": "8808",
"name": "Rika Sutanto",
"account_number": "8808999917965673",
"is_single_use": true,
"status": "PENDING",
"expiration_date": "2051-06-18T17:00:00.000Z",
"is_closed": false,
"id": "5eec3a3e8dd9ea2fc97d6728"
}
Get Virtual Account Payment
from xendit import VirtualAccount
virtual_account_payment = VirtualAccount.get(
payment_id="5ef18efca7d10d1b4d61fb52",
)
print(virtual_account)
Will return
{
"id": "5ef18efcf9ce3b5f8e188ee4",
"payment_id": "5ef18efca7d10d1b4d61fb52",
"callback_virtual_account_id": "5ef18ece8dd9ea2fc97d6a84",
"external_id": "VA_fixed-1592889038",
"merchant_code": "88608",
"account_number": "9999317837",
"bank_code": "MANDIRI",
"amount": 50000,
"transaction_timestamp": "2020-06-23T05:11:24.000Z"
}
Retail Outlet Service
Create Fixed Payment Code
from xendit import RetailOutlet
retail_outlet = RetailOutlet.create_fixed_payment_code(
external_id="demo_fixed_payment_code_123",
retail_outlet_name="ALFAMART",
name="Rika Sutanto",
expected_amount=10000,
)
print(retail_outlet)
Will return
{
"owner_id": "5ed75086a883856178afc12e",
"external_id": "demo_fixed_payment_code_123",
"retail_outlet_name": "ALFAMART",
"prefix": "TEST",
"name": "Rika Sutanto",
"payment_code": "TEST56147",
"expected_amount": 10000,
"is_single_use": False,
"expiration_date": "2051-06-23T17:00:00.000Z",
"id": "5ef2f0f8e7f5c14077275493",
}
Update Fixed Payment Code
from xendit import RetailOutlet
retail_outlet = RetailOutlet.update_fixed_payment_code(
fixed_payment_code_id="5ef2f0f8e7f5c14077275493",
name="Joe Contini",
)
print(retail_outlet)
Will return
{
"owner_id": "5ed75086a883856178afc12e",
"external_id": "demo_fixed_payment_code_123",
"retail_outlet_name": "ALFAMART",
"prefix": "TEST",
"name": "Joe Contini",
"payment_code": "TEST56147",
"expected_amount": 10000,
"is_single_use": False,
"expiration_date": "2051-06-23T17:00:00.000Z",
"id": "5ef2f0f8e7f5c14077275493",
}
Get Fixed Payment Code
from xendit import RetailOutlet
retail_outlet = RetailOutlet.get_fixed_payment_code(
fixed_payment_code_id="5ef2f0f8e7f5c14077275493",
)
print(retail_outlet)
Will return
{
"owner_id": "5ed75086a883856178afc12e",
"external_id": "demo_fixed_payment_code_123",
"retail_outlet_name": "ALFAMART",
"prefix": "TEST",
"name": "Rika Sutanto",
"payment_code": "TEST56147",
"expected_amount": 10000,
"is_single_use": False,
"expiration_date": "2051-06-23T17:00:00.000Z",
"id": "5ef2f0f8e7f5c14077275493",
}
Invoice Service
Create Invoice
from xendit import Invoice
invoice = Invoice.create(
external_id="invoice-1593684000",
amount=20000,
payer_email="customer@domain.com",
description="Invoice Demo #123",
)
print(invoice)
Will return
{
"id": "5efdb0210425db620ec35fb3",
"external_id": "invoice-1593684000",
"user_id": "5ed75086a883856178afc12e",
"status": "PENDING",
"merchant_name": "Xendit's Intern",
"merchant_profile_picture_url": "https://xnd-companies.s3.amazonaws.com/prod/1591169469152_279.png",
"amount": 20000,
"payer_email": "customer@domain.com",
"description": "Invoice Demo #123",
"expiry_date": "2020-07-03T10:00:01.148Z",
"invoice_url": "https://invoice-staging.xendit.co/web/invoices/5efdb0210425db620ec35fb3",
"available_banks": [
{
"bank_code": "MANDIRI",
"collection_type": "POOL",
"bank_account_number": "8860846854335",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "BRI",
"collection_type": "POOL",
"bank_account_number": "2621554807492",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "BNI",
"collection_type": "POOL",
"bank_account_number": "880854597383",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "PERMATA",
"collection_type": "POOL",
"bank_account_number": "821456659745",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "BCA",
"collection_type": "POOL",
"bank_account_number": "1076619844859",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
}
],
"available_retail_outlets": [
{
"retail_outlet_name": "ALFAMART",
"payment_code": "TEST34956",
"transfer_amount": 20000
}
],
"available_ewallets": [],
"should_exclude_credit_card": false,
"should_send_email": false,
"created": "2020-07-02T10:00:01.285Z",
"updated": "2020-07-02T10:00:01.285Z",
"currency": "IDR"
}
Get Invoice
from xendit import Invoice
invoice = Invoice.get(
invoice_id="5efda8a20425db620ec35f43",
)
print(invoice)
Will return
{
"id": "5efda8a20425db620ec35f43",
"external_id": "invoice-1593682080",
"user_id": "5ed75086a883856178afc12e",
"status": "EXPIRED",
"merchant_name": "Xendit's Intern",
"merchant_profile_picture_url": "https://xnd-companies.s3.amazonaws.com/prod/1591169469152_279.png",
"amount": 20000,
"payer_email": "customer@domain.com",
"description": "Invoice Demo #123",
"expiry_date": "2020-07-02T09:55:47.794Z",
"invoice_url": "https://invoice-staging.xendit.co/web/invoices/5efda8a20425db620ec35f43",
"available_banks": [
{
"bank_code": "MANDIRI",
"collection_type": "POOL",
"bank_account_number": "8860846853111",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "BRI",
"collection_type": "POOL",
"bank_account_number": "2621554806292",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
}
],
"available_retail_outlets": [
{
"retail_outlet_name": "ALFAMART",
"payment_code": "TEST34950",
"transfer_amount": 20000
}
],
"available_ewallets": [],
"should_exclude_credit_card": false,
"should_send_email": false,
"created": "2020-07-02T09:28:02.191Z",
"updated": "2020-07-02T09:55:47.794Z",
"currency": "IDR"
}
Expire Invoice
from xendit import Invoice
invoice = Invoice.expire(
invoice_id="5efda8a20425db620ec35f43",
)
print(invoice)
Will return
{
"id": "5efda8a20425db620ec35f43",
"external_id": "invoice-1593682080",
"user_id": "5ed75086a883856178afc12e",
"status": "EXPIRED",
"merchant_name": "Xendit's Intern",
"merchant_profile_picture_url": "https://xnd-companies.s3.amazonaws.com/prod/1591169469152_279.png",
"amount": 20000,
"payer_email": "customer@domain.com",
"description": "Invoice Demo #123",
"expiry_date": "2020-07-02T09:55:47.794Z",
"invoice_url": "https://invoice-staging.xendit.co/web/invoices/5efda8a20425db620ec35f43",
"available_banks": [
{
"bank_code": "MANDIRI",
"collection_type": "POOL",
"bank_account_number": "8860846853111",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "BRI",
"collection_type": "POOL",
"bank_account_number": "2621554806292",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
}
"available_retail_outlets": [
{
"retail_outlet_name": "ALFAMART",
"payment_code": "TEST34950",
"transfer_amount": 20000
}
],
"available_ewallets": [],
"should_exclude_credit_card": false,
"should_send_email": false,
"created": "2020-07-02T09:28:02.191Z",
"updated": "2020-07-02T09:55:47.794Z",
"currency": "IDR"
}
List All Invoice
from xendit import Invoice
invoices = Invoice.list_all(
limit=3,
)
print(invoices)
Will return
[
...
{
"id": "5efda8a20425db620ec35f43",
"external_id": "invoice-1593682080",
"user_id": "5ed75086a883856178afc12e",
"status": "EXPIRED",
"merchant_name": "Xendit's Intern",
"merchant_profile_picture_url": "https://xnd-companies.s3.amazonaws.com/prod/1591169469152_279.png",
"amount": 20000,
"payer_email": "customer@domain.com",
"description": "Invoice Demo #123",
"expiry_date": "2020-07-02T09:55:47.794Z",
"invoice_url": "https://invoice-staging.xendit.co/web/invoices/5efda8a20425db620ec35f43",
"available_banks": [
{
"bank_code": "MANDIRI",
"collection_type": "POOL",
"bank_account_number": "8860846853111",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
},
{
"bank_code": "BRI",
"collection_type": "POOL",
"bank_account_number": "2621554806292",
"transfer_amount": 20000,
"bank_branch": "Virtual Account",
"account_holder_name": "XENDIT'S INTERN",
"identity_amount": 0
}
"available_retail_outlets": [
{
"retail_outlet_name": "ALFAMART",
"payment_code": "TEST34950",
"transfer_amount": 20000
}
],
"available_ewallets": [],
"should_exclude_credit_card": false,
"should_send_email": false,
"created": "2020-07-02T09:28:02.191Z",
"updated": "2020-07-02T09:55:47.794Z",
"currency": "IDR"
}
...
]
Recurring Payment
Create Recurring Payment
from xendit import RecurringPayment
recurring_payment = RecurringPayment.create_recurring_payment(
external_id="recurring_12345",
payer_email="test@x.co",
description="Test Curring Payment",
amount=100000,
interval="MONTH",
interval_count=1,
)
Will return
{
"status": "ACTIVE",
"should_send_email": false,
"missed_payment_action": "IGNORE",
"recurrence_progress": 1,
"recharge": true,
"user_id": "5ed75086a883856178afc12e",
"external_id": "recurring_12345",
"payer_email": "test@x.co",
"description": "Test Curring Payment",
"amount": 100000,
"interval": "MONTH",
"interval_count": 1,
"start_date": "2020-07-08T08:22:55.815Z",
"currency": "IDR",
"created": "2020-07-08T08:22:55.817Z",
"updated": "2020-07-08T08:22:55.994Z",
"id": "5f05825ff9f52d3ed204c687",
"last_created_invoice_url": "https://invoice-staging.xendit.co/web/invoices/5f05825ff9f52d3ed204c688"
}
Get Recurring Payment
from xendit import RecurringPayment
recurring_payment = RecurringPayment.get_recurring_payment(
id="5f05825ff9f52d3ed204c687",
)
Will return
{
"status": "ACTIVE",
"should_send_email": false,
"missed_payment_action": "IGNORE",
"recurrence_progress": 1,
"recharge": true,
"user_id": "5ed75086a883856178afc12e",
"external_id": "recurring_12345",
"payer_email": "test@x.co",
"description": "Test Curring Payment",
"amount": 100000,
"interval": "MONTH",
"interval_count": 1,
"start_date": "2020-07-08T08:22:55.815Z",
"currency": "IDR",
"created": "2020-07-08T08:22:55.817Z",
"updated": "2020-07-08T08:22:55.994Z",
"id": "5f05825ff9f52d3ed204c687",
"last_created_invoice_url": "https://invoice-staging.xendit.co/web/invoices/5f05825ff9f52d3ed204c688"
}
Edit Recurring Payment
from xendit import RecurringPayment
recurring_payment = RecurringPayment.edit_recurring_payment(
id="5f05825ff9f52d3ed204c687",
interval_count=2,
)
Will return
{
"status": "ACTIVE",
"should_send_email": false,
"missed_payment_action": "IGNORE",
"recurrence_progress": 1,
"recharge": true,
"user_id": "5ed75086a883856178afc12e",
"external_id": "recurring_12345",
"payer_email": "test@x.co",
"description": "Test Curring Payment",
"amount": 100000,
"interval": "MONTH",
"interval_count": 2,
"start_date": "2020-07-08T08:22:55.815Z",
"currency": "IDR",
"created": "2020-07-08T08:22:55.817Z",
"updated": "2020-07-08T08:24:58.295Z",
"id": "5f05825ff9f52d3ed204c687"
}
Stop Recurring Payment
from xendit import RecurringPayment
recurring_payment = RecurringPayment.stop_recurring_payment(
id="5f05825ff9f52d3ed204c687",
)
Will return
{
"status": "STOPPED",
"should_send_email": false,
"missed_payment_action": "IGNORE",
"recurrence_progress": 1,
"recharge": true,
"user_id": "5ed75086a883856178afc12e",
"external_id": "recurring_12345",
"payer_email": "test@x.co",
"description": "Test Curring Payment",
"amount": 100000,
"interval": "MONTH",
"interval_count": 2,
"start_date": "2020-07-08T08:22:55.815Z",
"currency": "IDR",
"created": "2020-07-08T08:22:55.817Z",
"updated": "2020-07-08T08:26:32.464Z",
"id": "5f05825ff9f52d3ed204c687"
}
Pause Recurring Payment
from xendit import RecurringPayment
recurring_payment = RecurringPayment.pause_recurring_payment(
id="5f05825ff9f52d3ed204c687",
)
Will return
{
"status": "PAUSED",
"should_send_email": false,
"missed_payment_action": "IGNORE",
"recurrence_progress": 1,
"recharge": true,
"user_id": "5ed75086a883856178afc12e",
"external_id": "recurring_12345",
"payer_email": "test@x.co",
"description": "Test Curring Payment",
"amount": 100000,
"interval": "MONTH",
"interval_count": 2,
"start_date": "2020-07-08T08:22:55.815Z",
"currency": "IDR",
"created": "2020-07-08T08:22:55.817Z",
"updated": "2020-07-08T08:25:44.580Z",
"id": "5f05825ff9f52d3ed204c687"
}
Resume Recurring Payment
from xendit import RecurringPayment
recurring_payment = RecurringPayment.resume_recurring_payment(
id="5f05825ff9f52d3ed204c687",
)
Will return
{
"status": "ACTIVE",
"should_send_email": false,
"missed_payment_action": "IGNORE",
"recurrence_progress": 1,
"recharge": true,
"user_id": "5ed75086a883856178afc12e",
"external_id": "recurring_12345",
"payer_email": "test@x.co",
"description": "Test Curring Payment",
"amount": 100000,
"interval": "MONTH",
"interval_count": 2,
"start_date": "2020-07-08T08:22:55.815Z",
"currency": "IDR",
"created": "2020-07-08T08:22:55.817Z",
"updated": "2020-07-08T08:26:03.082Z",
"id": "5f05825ff9f52d3ed204c687"
}
Disbursement Service
Create Disbursement
from xendit import Disbursement
disbursement = Disbursement.create(
external_id="demo_1475459775872",
bank_code="BCA",
account_holder_name="Bob Jones",
account_number="1231242311",
description="Reimbursement for shoes",
amount=17000,
)
print(disbursement)
Will return
{
"user_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"amount": 17000,
"bank_code": "BCA",
"account_holder_name": "Bob Jones",
"disbursement_description": "Reimbursement for shoes",
"status": "PENDING",
"id": "5ef1c4f40c2e150017ce3b96",
}
Get Disbursement by ID
from xendit import Disbursement
disbursement = Disbursement.get(
id="5ef1befeecb16100179e1d05",
)
print(disbursement)
Will return
{
"user_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"amount": 17000,
"bank_code": "BCA",
"account_holder_name": "Bob Jones",
"disbursement_description": "Disbursement from Postman",
"status": "PENDING",
"id": "5ef1befeecb16100179e1d05"
}
Get Disbursement by External ID
from xendit import Disbursement
disbursement_list = Disbursement.get_by_ext_id(
external_id="demo_1475459775872",
)
print(disbursement_list)
Will return
[
{
"user_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"amount": 17000,
"bank_code": "BCA",
"account_holder_name": "Bob Jones",
"disbursement_description": "Reimbursement for shoes",
"status": "PENDING",
"id": "5ef1c4f40c2e150017ce3b96",
},
{
"user_id": "5ed75086a883856178afc12e",
"external_id": "demo_1475459775872",
"amount": 17000,
"bank_code": "BCA",
"account_holder_name": "Bob Jones",
"disbursement_description": "Disbursement from Postman",
"status": "PENDING",
"id": "5ef1befeecb16100179e1d05",
},
...
]
Get Available Banks
from xendit import Disbursement
disbursement_banks = Disbursement.get_available_banks()
print(disbursement_banks)
Will return
[
...
{
"name": "Mandiri Taspen Pos (formerly Bank Sinar Harapan Bali)",
"code": "MANDIRI_TASPEN",
"can_disburse": True,
"can_name_validate": True,
},
{
"name": "Bank QNB Indonesia (formerly Bank QNB Kesawan)",
"code": "QNB_INDONESIA",
"can_disburse": True,
"can_name_validate": True,
}
]
Contributing
For any requests, bugs, or comments, please open an issue or submit a pull request.
To start developing on this repository, you need to have Poetry installed for package dependency. After that, you can run poetry install to install the dependency. To enter the environment, run poetry shell
Tests
Running the Test
Make sure the the code passes all tests.
Run the test:
python -m pytest tests/
Run with coverage:
python -m pytest tests/ --cov=xendit/
Creating Custom HTTP Client
To create your own HTTP Client, you can do it by implementing interface at xendit/network/http_client_interface.py. Our default HTTP Client are wrapper of requests, which can be found at xendit/network/_xendit_http_client.py. To attach it to your instance, add it to your xendit parameter.
import xendit
xendit_instance = xendit.Xendit(api_key='', http_client=YourHTTPClientClass)
FAQs
Xendit REST API Client for Python - Card, Virtual Account, Invoice, Disbursement, Recurring Payments, Payout, EWallet, Balance, Retail Outlets Services https://xendit.github.io/apireference/
We found that xendit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Research
Security News
Malicious npm Packages Use Telegram to Exfiltrate BullX Credentials
Socket uncovers an npm Trojan stealing crypto wallets and BullX credentials via obfuscated code and Telegram exfiltration.
By Kush Pandya - May 08, 2025
Research
Security News
Backdooring the IDE: Malicious npm Packages Hijack Cursor Editor on macOS
Malicious npm packages posing as developer tools target macOS Cursor IDE users, stealing credentials and modifying files to gain persistent backdoor access.
By Kirill Boychenko - May 07, 2025