Singapay Home Page
Logo Icon
  1. Disbursement
  2. Disbursements Transfer

Information

MethodPathFormatAuthentication
POST/api/v1.0/disbursements/transfer/{account_id}jsonOAuth 2.0 with Access Token

Request Details

Headers Structure

FieldValueTypeMandatoryLengthDescriptionExample
X-PARTNER-IDapi_keyAlphanumericMandatoryAPI key obtained from the merchant dashboard.b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Acceptapplication/jsonAlphabeticMandatorySpecifies JSON as the expected response format.application/json
AuthorizationBearer {bearerToken}AlphanumericMandatoryBearer token obtained from the get access token endpoint.Bearer eyJ0eXAiOiJKV1{…}

Body Structure

FieldTypeMandatoryLengthDescriptionExample
passwordAlphanumeric-12Password with alphanumeric characterss0M3$tROn6.pSsWd
bank_account_numberNumericMandatory-Bank account number283434
notesAlphabetic--Additional notes-
amountNumericMandatory-Transaction amount99000
currencyAlphabetic--Currency type-
bank_swift_codeNumericMandatory8Bank swift codeBBRINJA

Body Example

{
  "password": "s0M3$tROn6.pSsWd",
  "amount": "11000.00",
  "currency": "IDR",
  "bank_swift_code": "BBRINJA",
  "bank_account_number": "63434554",
  "notes": "lorem ipsum"
}

Response Details

Response Structure

FieldTypeMandatoryLengthDescriptionExample
statusNumericMandatory3HTTP Status Code200
successBooleanMandatory12xx is true. 4xx-500 is false.true
dataObjectConditional---
> transaction_idNumericMandatory-Transaction id36455454
> statusAlphabeticMandatory-Transaction status. Value will be success, failed, pendingsuccess
> bank_codeAlphabeticMandatory-Bank code like BRI, BNI, DANAMONBRI
> bank_account_numberNumericMandatory-Beneficiary Bank account number283434
> bank_account_nameAlphabetic--Beneficiary Bank account name-
> post_timestampTimestampMandatory-Date requested with Unix timestamp millisecond format1714618220440
> processed_timestampTimestamp--Date finished with Unix timestamp millisecond format-
> notesAlphabetic--Additional notes-
> amountObjectMandatory---
>> valueNumericMandatory-Transaction amount the recipient will receive11000.00
>> currencyAlphabeticMandatory3Currency typeIDR
> feesArrayMandatory---
>> nameAlphabetic--Transaction fee name-
>> valueNumericMandatory-Transaction fee2000.00
>> currencyAlphabeticMandatory3Currency typeIDR
> total_amountObjectMandatory---
>> valueNumericMandatory-Total transaction amount the recipient will receive11000.00
>> currencyAlphabeticMandatory3Currency typeIDR
> source_accountObjectMandatory---
>> account_idNumeric--Source account id-
> balance_afterObjectMandatory---
>> currencyAlphabeticMandatory3Currency typeIDR
>> valueNumericMandatory-Balance after transaction13000.00

Response Example

Success: Here’s an example of a successful response.

{
  "status": 200,
  "success": true,
  "data": {
    "status": 200,
    "success": true,
    "data": {
      "id": "4565456565",
      "status": "success",
      "amount": {
        "value": "11000.00",
        "currency": "IDR"
      },
      "fees": [
        {
          "name": "transfer service fee name",
          "value": "2000.00",
          "currency": "IDR"
        }
      ],
      "total_amount": {
        "value": "13000.00",
        "currency": "IDR"
      },
      "bank": {
        "code": "BRI",
        "account_number": "63434554",
        "account_name": "John Doe"
      },
      "processed_timestamp": "1714618220440",
      "post_timestamp": "1714618220440",
      "notes": "lorem ipsum"
    },
    "balance_after": {
      "value": "11000.00",
      "currency": "IDR"
    }
  }
}

Error: This is an example of an unsuccessful request.

{
    "status": 401,
    "success": false,
    "error": {
        "code": 401,
        "message": "Unauthorized partner, please sign in"
    }
}