Create a payment method

post

https://sandbox-id.xfers.com/api/v4/payment_methods/{type}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Available banks

Bank	bankShortCode
BCA	BCA
BNI	BNI
BRI	BRI
CIMB Niaga	CIMB_NIAGA
Danamon	DANAMON
Hana	HANA
Mandiri	MANDIRI
Permata	PERMATA
Bank Sahabat Sampoerna	SAHABAT_SAMPOERNA
Bank Syariah Indonesia	BSI

Example of Virtual Account Payment Method request

# /api/v4/payment_methods/virtual_bank_accounts
{
  "data": {
    "attributes": {
      "bankShortCode": "BRI",
      "referenceId": "virtual_account_ref_id",
      "displayName": "Your virtual account display name"
    }
  }
}

# Virtual Account
{
    "data": {
        "id": "va_ab2fae95a6e2d223b133821e80b82916",
        "type": "virtual_bank_account",
        "attributes": {
            "referenceId": "virtual_account_ref_id",
            "instructions": {
                "bankShortCode": "BRI",
                "accountNo": "1234567812345678",
                "displayName": "Your virtual account display name"
            }
        }
    }
}

Path Params

type

string

required

Defaults to virtual_bank_accounts

The type of payment method. Currently support "virtual_bank_accounts" and "qris".

Body Params

bankShortCode

string

required

Defaults to BNI

The bank code used for creating the virtual account Payment Method. This should clearly identify a bank in the region that you want your customer to make a transfer to. This should usually be the bank that the end-customer will be making a transfer from. See below for a list of supported banks.

referenceId

string

required

Defaults to va_reference_id

The referenceId that was used to request for the Payment Method. This is used for idempotency and should typically be a "customer id" or "wallet id" on your platform.

displayName

string

required

Defaults to Nama Tampilan

Name to be displayed in the corresponding bank system such as ATM confirmation screen, or online bank transfer screen. If empty, it will be given a default value that is the display name you have set on the Xfers Dashboard.

Response

Available banks

Example of Virtual Account Payment Method request

201201