Virtual account

provisionAccount

/v-accounts/provision

Request parameters

{
  "expiryType": "SINGLE_USE",
  "requestingInstitutionName": "example",
  "amount": 96,
  "validityPeriod": 53,
  "partnerReference": "example",
  "settlementAccountNumber": "example",
  "callbackUrl": "example"
}

Responses

{
  "expiryType": "SINGLE_USE",
  "transactionId": "example",
  "partnerReference": "example",
  "virtualAccountNumber": "example",
  "dateCreated": "1994-05-16T18:59:55Z",
  "expireDate": "1999-04-28T14:40:46Z",
  "accountStatus": "USED",
  "requestingInstitutionName": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

getVirtualAccountNumber

/v-accounts/name-query/{virtual_account}

Request parameters

Responses

{
  "expiryType": "SINGLE_USE",
  "transactionId": "example",
  "amount": 96,
  "validityPeriod": 53,
  "partnerReference": "example",
  "virtualAccountNumber": "example",
  "settlementAccountNumber": "example",
  "callbackUrl": "example",
  "dateCreated": "1994-05-16T18:59:55Z",
  "expireDate": "1999-04-28T14:40:46Z",
  "accountStatus": "USED",
  "expired": false,
  "requestingInstitutionName": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

queryTransaction

/v-accounts/transactions

Request parameters

Responses

{
  "offset": 49,
  "limit": 43,
  "transactions": [
    {
      "transactionId": "example",
      "partnerReference": "example",
      "virtualAccountNumber": "example",
      "amount": 96,
      "expiryType": "SINGLE_USE",
      "dateCreated": "1994-05-16T18:59:55Z",
      "expired": false,
      "transactionDetails": [
        {
          "virtualAccountNumber": "example",
          "amount": 96,
          "trackingNumber": "example",
          "sessionId": "example",
          "ghipssTimestamp": "2004-10-11T22:39:51Z",
          "transactionStatus": "SUCCESS"
        }
      ]
    }
  ]
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

getTransactionByVirtualAccount

/v-accounts/transactions/{transaction_id}

Request parameters

Responses

{
  "transactionId": "example",
  "partnerReference": "example",
  "virtualAccountNumber": "example",
  "amount": 96,
  "expiryType": "SINGLE_USE",
  "dateCreated": "1994-05-16T18:59:55Z",
  "expired": false,
  "transactionDetails": [
    {
      "virtualAccountNumber": "example",
      "amount": 96,
      "trackingNumber": "example",
      "sessionId": "example",
      "ghipssTimestamp": "2004-10-11T22:39:51Z",
      "transactionStatus": "SUCCESS"
    }
  ]
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

expireAccount

/v-accounts/expire-account/{virtual_account}

Request parameters

Responses

{
  "virtualAccountNumber": "example",
  "expireDate": "1999-04-28T14:40:46Z",
  "expired": false
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

statusQuery

/v-accounts/status-query/{virtual_account}

Request parameters

Responses

{
  "virtualAccountNumber": "example",
  "transactionId": "example",
  "partnerReference": "example",
  "expiryDate": "1998-09-26T20:00:26Z",
  "expired": false
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

{
  "message": "example",
  "statusCode": 99,
  "reason": "example"
}

Resend Callback

/v-accounts/resend-callback/{partnerReference}

Request parameters

Responses

{
  "ConfirmTransactionResponse": {
    "success": false
  }
}

{
  "AppResponse": {
    "message": "example",
    "statusCode": 99,
    "reason": "example"
  }
}

{
  "AppResponse": {
    "message": "example",
    "statusCode": 99,
    "reason": "example"
  }
}

Last modified: 27 August 2025