Direct credit to account

POST /payment/direct-credit

Api key auth

Credit funds directly to a specified account. This is typically used for deposits, refunds, or system credits.

application/json

Body Required

data object Required

The actual request data to be processed
Hide data attributes Show data attributes object
- targetAccountId string Required
  
  ID of the account to credit
- amount number Required
  
  Amount to credit (in smallest currency unit)
- currency string Required
  
  Currency code
- reference string Required
  
  Reference for the credit
- description string
  
  Optional description
signature string Required

ed25519 signature of the data, signed with user's private key
publicKey string Required

User's derived public key for signature verification
timestamp integer Required

Unix timestamp when the request was created (milliseconds)
nonce string Required

Unique nonce to prevent replay attacks

Responses

201 application/json

Credit transaction created successfully
Hide response attributes Show response attributes object
- success boolean
- transactionId string
  
  Unique transaction identifier
- status string
  
  Values are pending, completed, or failed.
- amount number
- currency string
- timestamp string(date-time)
400

Invalid request parameters
401

Authentication failed
403

Insufficient permissions
429

Rate limit exceeded
500

Internal server error

POST /payment/direct-credit

curl \
 --request POST 'https://pay-api-dev.aiic.nz/v1/payment/direct-credit' \
 --header "X-Public-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"data":{"targetAccountId":"acc_123","amount":1000,"currency":"NZD","reference":"Deposit from POLi","description":"Direct credit to account"},"signature":"base64-encoded-signature","publicKey":"base64-encoded-public-key","timestamp":1703123456789,"nonce":"abc123-def456-ghi789"}'

Request examples

{
  "data": {
    "targetAccountId": "acc_123",
    "amount": 1000,
    "currency": "NZD",
    "reference": "Deposit from POLi",
    "description": "Direct credit to account"
  },
  "signature": "base64-encoded-signature",
  "publicKey": "base64-encoded-public-key",
  "timestamp": 1703123456789,
  "nonce": "abc123-def456-ghi789"
}

Response examples (201)

{
  "success": true,
  "transactionId": "txn_abc123",
  "status": "completed",
  "amount": 1000,
  "currency": "NZD",
  "timestamp": "2025-05-04T09:42:00Z"
}