Create a payment

Creates a payment for the given amount and method. Returns the payment with a pending status until the customer completes it.

POST/payments

Authorization

AuthorizationBearer token · headerrequired

Your Apipay secret API key.

Request body

requiredapplication/json

amountintegerrequired

currencystringrequired

default: "IDR"

methodPaymentMethodrequired

Allowed:qrisvirtual_accountcardewallet

customer_idstring

descriptionstring

Responses

201

The created payment.

idstringrequired

amountintegerrequired

Amount in the smallest unit of the currency (e.g. Rupiah has no sub-unit, so this is whole Rupiah).

currencystringrequired

methodPaymentMethodrequired

Allowed:qrisvirtual_accountcardewallet

statusPaymentStatusrequired

Allowed:pendingsucceededfailedcanceled

customer_idstring | null

descriptionstring | null

created_atstring<date-time>required

400

The request was malformed or missing a required field.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

401

The API key is missing, invalid, or revoked.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

amountinteger*currencystring*methodstring*customer_idstringdescriptionstring

Request

curl -X POST 'https://api.apipay.id/v1/payments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 150000,
  "currency": "IDR",
  "method": "qris",
  "customer_id": "cus_8f3a2b1c",
  "description": "Order"
}'

const response = await fetch("https://api.apipay.id/v1/payments", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"amount\": 150000,\n  \"currency\": \"IDR\",\n  \"method\": \"qris\",\n  \"customer_id\": \"cus_8f3a2b1c\",\n  \"description\": \"Order\"\n}"
});

import requests

response = requests.post(
    "https://api.apipay.id/v1/payments",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"amount\": 150000,\n  \"currency\": \"IDR\",\n  \"method\": \"qris\",\n  \"customer_id\": \"cus_8f3a2b1c\",\n  \"description\": \"Order\"\n}",
)

Response

{
  "id": "pay_6b2f9d4e",
  "amount": 150000,
  "currency": "IDR",
  "method": "qris",
  "status": "pending",
  "customer_id": "cus_8f3a2b1c",
  "description": "Order",
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer"
  }
}