v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Payments

Make a payment to IRD

Initiate a tax payment from user's connected bank account to 🔗 Inland Revenue Department.

For more details about payments see:

📚 Making a payment guide
📚 Payment lifecycle guide
📖 Payment webhooks

post/payments/ird

Headers

X-Akahu-Idstring required

Your App ID Token.

Content-Typestring

Request body

fromstring required

The Akahu Account ID you want to pay from

amountnumber required

The payment amount

Example request

{
  "from": "acc_1111111111111111111111111",
  "amount": 9.5,
  "meta": {
    "tax_number": "123-456-789",
    "tax_type": "DED",
    "tax_period": "2022-01-31"
  }
}

Response

Successful response.

successboolean

item_idstring

⚠️ Deprecated The Akahu Payment ID replaced via item._id

statusstring

⚠️ Deprecated The Akahu Payment status replaced via item.status

Example response

{
  "item": {
    "_id": "payment_1111111111111111111111111",
    "from": "acc_1111111111111111111111111",
    "to": {
      "account_number": "12-1234-1234567-12",
      "name": "John Smith"
    },
    "amount": 9.51,
    "meta": {
      "destination": {
        "particulars": "destPart",
        "code": "destCode",
        "reference": "destRef"
      },
      "source": {
        "code": "sourceCode",
        "reference": "sourceRef"
      }
    },
    "sid": "akp111111111",
    "status": "READY",
    "status_text": "This payment has just been created and is ready to be sent",
    "timeline": [
      {
        "status": "READY",
        "time": "2020-01-01T01:00:00.000Z",
        "eta": "2020-01-01T01:00:00.000Z"
      }
    ],
    "created_at": "2020-01-01T01:00:00.000Z",
    "updated_at": "2020-01-01T01:00:00.000Z",
    "received_at": "2020-01-01T01:00:00.000Z"
  },
  "item_id": "payment_1111111111111111111111111",
  "status": "READY"
}