MImidtrans

Create Disbursement Link API

post/v1/transfer-links

Request

  • Base URL
    https://api.sandbox.midtrans.com
  • URL
    https://api.sandbox.midtrans.com/v1/transfer-links
  • Auth
    HTTP basic

Headers

X-Request-Idstring

A unique id that used to identify a single request

X-Idempotency-Keystring

Idempotency key to safely handle requests.

Request body

amountinteger required

Net amount of the transaction. Currently supporting IDR.

type'DISBURSEMENT' required

The type of disbursement link transaction. Currently supporting "DISBURSEMENT".

remarkstring required

Remark / transaction description. Uniqueness is encouraged. It is restricted to a maximum of 50 characters.

reference_nostring

Transaction number that you can customize or pre-generated for transfer link (only if transfer is present, currently supporting alphanumeric).

beneficiary_namestring

Beneficiary Name can also be optional.

beneficiary_emailstring

Beneficiary Email is optional by default (only mandatory for password flow).

titlestring

Title of the Disbursement Link (by default "General Disbursement")

expiry_datestring

Expiry date in RFC-3339 format.

Response

200

successboolean
errorsobject[]

Example response

{
  "success": true,
  "data": {
    "id": "OySy7sfvvgU5JjVR8dSiK0kk",
    "disbursement_url": "https://app.midtrans.com/disbursement-links/QsSjdh12y397sa"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.