Linkage

Payment Linkage

Payment Linkage merupakan layanan yang dapat digunakan untuk melakukan pembayaran, setelah akun e-wallet sudah terhubung.
Tipe Value
Kode Layanan
54
Nama
Direct Debit Payment
HTTP Method
POST

Flow

Anda melakukan permintaan dengan mengirimkan parameter yang dibutuhkan, dan Espay Payment Gateway akan memberikan respons dalam bentuk JSON.

API URL

Environment URL
Sandbox
Port of HTTPS (443)
https://sandbox-api.espay.id/apimerchant/v1.0/debit/payment-host-to-host
Production
Port of HTTPS (443)
https://api.espay.id/apimerchant/v1.0/debit/payment-host-to-host
Nama Tipe Mandatory Keterangan
Content-Type
String
Y
Isi konten permintaan Anda.

Contoh:
application/json
X-TIMESTAMP
String (25)
Y
Tanggal dan waktu lokal customer saat ini.

Format:
yyyy-MM-ddThh:mi:ssTZD (ISO 8601)

Contoh:
2024-03-14T07:49:28+07:00
X-SIGNATURE
String (255)
Y
Kode yang digunakan untuk melakukan validasi transaksi. Pelajari Signature Asymmetric
X-EXTERNAL-ID
String (32)
Y
String Numerik. Kode referensi yang bersifat unik pada hari yang sama.
X-PARTNER-ID
String (50)
Y
Merchant code yang diberikan oleh tim Espay.
CHANNEL-ID
String (5)
Y
Kode channel.

Value:
ESPAY
Authorization-Customer
String (150)
C
Kode token B2B2C. Khusus Espay -> Bank.
Y: Yes, O: Optional, C: Conditional

Parameter Permintaan

Parameter Tipe Mandatory Keterangan
partnerReferenceNo
String (32)
Y
Kode unik untuk mengidentifikasi pesanan / penagihan / faktur.

Contoh:
Nomor transaksi, invoice id, dll.
merchantId
String (28)
Y
Merchant code yang diberikan oleh tim Espay.

Contoh:
SGWYESSISHOP
subMerchantId
String (128)
O
API Key yang diberikan oleh tim Espay.
amount
Object
Y
  value
String (16.2)
Y
Total pembayaran.

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
  currency
String (3)
Y
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
    		•
    urlParam
    Object
      url
    String (255)
    Y
    URL yang mengarahkan ke halaman merchant (callback).
      type
    String (32)
    Y
    Tipe URL.

    Value:
    PAY_RETURN
      isDeeplink
    String (1)
    Y
    Status Deep Link. Khusus SNAP value yang didukung hanya N (Tidak).

    Format:
    • Ya: Y
    • Tidak: N
    validUpTo
    String (25)
    O
    Tanggal dan waktu kedaluwarsa transaksi.

    Format:
    yyyy-MM-ddThh:mi:ssTZD (ISO 8601)

    Contoh:
    2022-08-21T14:56:11+07:00
    pointOfInitiation
    String (20)
    O
    Informasi mengenai sumber request merchant.

    Contoh:
    Web, Mobile, POS, dll.
    payOptionDetails
    Object
      payMethod
    String (64)
    Y
    Kode bank. Lihat disini.
      payOption
    String (64)
    Y
    Nama produk. Lihat disini.
      transAmount
    Object
        value
    String (16.2)
    Y
    Total pembayaran.

    Format:
    Desimal .00 (ISO 4217)

    Contoh:
    150000.00
        currency
    String (3)
    Y
    Kode mata uang transaksi.

    Format:
    • Rupiah: IDR
      feeAmount
    Object
        value
    String (16.2)
    Y
    Biaya transaksi.

    Format:
    Desimal .00 (ISO 4217)

    Contoh:
    4400.00
        currency
    String (3)
    Y
    Kode mata uang transaksi.

    Format:
    • Rupiah: IDR
    additionalInfo
    Object
      payType
    String (20)
    Y
    Tipe Pembayaran.

    Format:
    • Redirect: REDIRECT
    • Paylink: PAYLINK
    • S2BPay: S2BPAY
      userId
    String (20)
    O
    Id user.
      userName
    String (64)
    O
    Nama customer.
      userEmail
    String (64)
    O
    Email customer.
      userPhone
    String (16)
    O
    No handphone customer.
      buyerId
    String (8)
    O
    ID unik merchant khusus virtual account statis. Digunakan oleh Espay untuk validasi transaksi.
      productCode
    String (16)
    Y
    Kode produk.

    Format:
    • GOPAYLINK
    • OVOLINK
    • DANALINK
      balanceType
    String (70)
    C
    Jenis saldo pada akun.

    Format:
    • CASH
    • POINT
    • GOPAY_WALLET
    • PAY_LATER
      bankCardToken
    String (64)
    C
    Akun token dari layanan Account Binding.
    Y: Yes, O: Optional, C: Conditional

    Parameter Respons

    Parameter Tipe Mandatory Keterangan
    responseCode
    String (7)
    Y
    Kode respons.

    Format:
    Kode HTTP + Kode Layanan + Kode Error

    Contoh:
    200+54+00 = 2005400.
    responseMessage
    String (150)
    Y
    Deskripsi respons.
    partnerReferenceNo
    String (64)
    Y
    Kode unik untuk mengidentifikasi pesanan / penagihan / faktur.

    Contoh:
    Nomor transaksi, invoice id, dll.
    webRedirectUrl
    String (2048)
    Y
    URL untuk mengarahkan ke halaman pembayaran.
    Y: Yes, O: Optional, C: Conditional
    Mandatory API

    Anda diharuskan untuk menyediakan callback yang dapat diakses oleh Espay Payment Gateway. Pelajari lebih lanjut Inquiry dan Payment

    Try It!

    Anda bisa coba masukkan data sesuai dengan input yang telah disediakan. Setelah itu Anda submit dan lihat hasilnya!

    Request

    Value

    Response
































    Contoh Header
    
Content-Type:application/json
X-TIMESTAMP:2024-03-14T07:49:28+07:00
X-SIGNATURE:B0VF16Vjsxxb/rUcgZM401XH7Z9cB5mhmYnfMdkblq84akTybh9Bakmb9nJD/ttrADmUbDJDW7s6E7yYTEATCdbjPs3+xEgA53gdcM7aJP9qPcfe79GankZrRvROcICdxuN2rjYZOuzvJ9SrfG/llmGic1bM627Eiz/G4pf7e8r6MOfsBRoUqH+moBGcw+/Xh2V8hqfb64hIzb7JZNZnVV7fQN6NZ8VAWLzjmo8PFLjg390wL3Fybr0GJwHohCaxBhv6P0nxVP+P9psnljKWt8EYHHWizgSVinUa9kncRq2MEpvLwujGcSG/MteZhcKXXYNGbCO5u7qato19fWwxaw==
X-EXTERNAL-ID:6b13fe32-0a63-4af2-911b-e6c9a0f9c7f4
X-PARTNER-ID:SGWYESSISHOP
CHANNEL-ID:ESPAY

























    Contoh Permintaan
    
{
    "partnerReferenceNo": "DIGORDER000001",
    "merchantId": "SGWYESSISHOP",
    "subMerchantId": "fd322d0f036c8443d6904973c1a329bd", 
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "urlParam": {
        "url": "https://yourthankyoupage.com",
        "type": "PAY_RETURN",
        "isDeeplink": "N"
    },
    "validUpTo": "2023-12-23T07:44:11+07:00",
    "pointOfInitiation": "Website",
    "payOptionDetails": {
        "payMethod": "014",
        "payOption": "BCAATM",
        "transAmount": {
            "value": "10000.00",
            "currency": "IDR"
        },
        "feeAmount": {
            "value": "10000.00",
            "currency": "IDR"
        }
    },
    "additionalInfo": {
        "payType": "REDIRECT",
        "userId": "425666",
        "userName": "Agung Setiadi Putra",
        "userEmail": "agung@agung.com",
        "userPhone": "082231838297",
        "buyerId": "12345678",
        "productCode": "OVOLINK",
        "balanceType": "CASH",
        "bankCardToken": "ESP230929094046rRD5mCT1IZkrBhJb5"
    }
}


































































































    Contoh Respons Positif
    
{
  "responseCode": "2005400",
  "responseMessage": "Successful",
  "partnerReferenceNo": "DIGORDER000001",
  "approvalCode": "20240314180833",
  "webRedirectUrl": "https://sandbox-kit.espay.id/index/order/?url=https://google.com&paymentId=DIGORDER000001&paymentAmount=10000&commCode=SGWYESSISHOP&bankCode=014&productCode=BCAATM"
}


    Contoh Respons Negatif
    
{
  "responseCode": "4015400",
  "responseMessage": "Unauthorized. Invalid Signature from Client"
}


    cURL
    
curl --location 'https://sandbox-api.espay.id/apimerchant/v1.0/debit/payment-host-to-host' \
--header 'X-TIMESTAMP: 2024-03-14T07:49:28+07:00' \
--header 'X-SIGNATURE: B0VF16Vjsxxb/rUcgZM401XH7Z9cB5mhmYnfMdkblq84akTybh9Bakmb9nJD/ttrADmUbDJDW7s6E7yYTEATCdbjPs3+xEgA53gdcM7aJP9qPcfe79GankZrRvROcICdxuN2rjYZOuzvJ9SrfG/llmGic1bM627Eiz/G4pf7e8r6MOfsBRoUqH+moBGcw+/Xh2V8hqfb64hIzb7JZNZnVV7fQN6NZ8VAWLzjmo8PFLjg390wL3Fybr0GJwHohCaxBhv6P0nxVP+P9psnljKWt8EYHHWizgSVinUa9kncRq2MEpvLwujGcSG/MteZhcKXXYNGbCO5u7qato19fWwxaw==' \
--header 'X-EXTERNAL-ID: 76d1c963-9cd6-4f15-abf7-64ebb71db1a3' \
--header 'X-PARTNER-ID: SGWYESSISHOP' \
--header 'CHANNEL-ID: ESPAY' \
--header 'Content-Type: application/json' \
--data-raw '{
"partnerReferenceNo": "DIGORDER000001",
"merchantId": "SGWYESSISHOP",
"subMerchantId": "fd322d0f036c8443d6904973c1a329bd", 
"amount": {
  "value": "10000.00",
  "currency": "IDR"
},
"urlParam": {
  "url": "https://yourthankyoupage.com",
  "type": "PAY_RETURN",
  "isDeeplink": "N"
},
"validUpTo": "2023-12-23T07:44:11+07:00",
"pointOfInitiation": "Website",
"payOptionDetails": {
  "payMethod": "014",
  "payOption": "BCAATM",
  "transAmount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "feeAmount": {
    "value": "10000.00",
    "currency": "IDR"
  }
},
"additionalInfo": {
  "payType": "REDIRECT",
  "userId": "425666",
  "userName": "Agung Setiadi Putra",
  "userEmail": "agung@agung.com",
  "userPhone": "082231838297",
  "buyerId": "12345678"
}
}
'





    Scroll to Top