Create Pay In Request

post

https://openapi.sandbox.xenithpay.com/v1/payins

You can use this endpoint to create a Pay In request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

initiatedAmount

number

required

Requested amount of the transaction in the actual value in the provided currency.

currency

string

required

ISO 4217 three-letter code of the transaction's currency.

paymentMethod

string

required

Payment method for this transaction. List of supported methods can be found here.

paymentChannel

string

required

Payment channel for this transaction. List of supported channels can be found here.

customerPhoneNumber

string

Customer's phone number (numeric, starts with 08, 628, or +628). Required when payment channel is OVO.

referenceCode

string

required

Merchant-provided identifier for this transaction.

customerReference

string

required

Merchant-provided identifier of the Customer for this transaction.

customerName

string

required

Merchant-provided name of the Customer for this transaction (minimum 5 characters).

description

string

Free-text field for any additional information.

callbackUrl

uri

required

Your webhook URL to receive transaction notifications.

redirectUrl

uri

required

URL where the end-customer is redirected to after the transaction is completed.

metadata

object

Metadata required for THB payment requests when using the PROMPTPAY payment channel. This object must include the required bank account name and account number to enable payment processing.

Metadata required for LAK payment requests when using LAOQR payment channel. This object must include the required bank id, bank account name and account number to enable payment processing.

Headers

Content-Type

string

required

Specifies the format of the request body (JSON).

Xenith-Api-Key

string

required

API Key will be delivered to you by email

Xenith-Request-Timestamp

string

required

ISO 8601 date time format, should be in (UTC+0)

Xenith-Request-Signature

string

required

Refer to page Build Signature and Set Headers for instructions on how to build a signature

X-Idempotency-Key

string

required

A unique key to prevent duplicate requests. Must be unique across all payin transactions for the merchant. Max 100 characters.

Responses

Callback

201Successfully creating pay in request

400Payment creation failed due to failing request validation. See the Pay In Errors dictionary for more detail.