Documentation

Internal Transfer

Suggest Edits

Internal Value Transfer API

This API facilitates the internal transfer of monetary values exclusively between accounts belonging to the same partner. Transfers are strictly internal, ensuring that both the source and destination accounts are within the same partner's scope. Users can specify the destination account and transfer value.

Endpoints

Initiate Transfer

POST /partners-int/accounts/transfer

Description: Transfer value from current context account to destination account for the same partner

Request Body:

{
    "refAccountCredit": "b773c60a-0550-431e-94a7-24a762594e03", //UID - from /partners-int/accounts
    "transferAmount": "0.50", // Amount to transfer
    "transferDescription": "Test transfer" //Optional description
}

Details

  • Account Ownership: Both origin and destination accounts must belong to the same brand or partner.
  • refAccountCredit this is the UID of your destination account, you can retrieve the list of your accounts using https://dev.paybrokers.com/reference/get-accounts
  • Transfer Amount must fall within the pre-defined minimum and maximum limits delimited by PayBrokers operation. Default is min 1 BRL.
  • Transfer Description: Optional description for your transfer

❗️

Available Funds

Before transfering between your accounts, please check available funds at:

https://dev.paybrokers.com/docs/check-balance

Example Success Response

{
    "statusCode": "Done",
    "data": {
        "id": "b773c60a-0550-431e-94a7-24a762594e03",
        "settlementDate": "2024-12-20T18:16:09.016208"
    }
}

Example Error Response

{
    "statusCode": "Error",
    "error": {
        "name": "InvalidInputError",
        "code": "InvalidInputError",
        "details": {
            "reason": "TransferAmountMustBeGreaterThanZero",
            "message": "Transfer amount must be greater than 0"
        }
    }
}

{
    "statusCode": "Error",
    "error": {
        "name": "AuthenticationError",
        "code": "AuthenticationError",
        "details": {
            "reason": "CustomerAccountIsNotActive"
        }
    }
}

{
    "statusCode": "Error",
    "error": {
        "name": "EntityNotFound",
        "code": "EntityNotFound",
        "details": {
            "entityName": "CustomerAccountEntity",
            "parameterName": "uid",
            "parameterValue": "e3d47ca8-c1db-4434-8b10-example1a6a2ed",
            "message": "Could not find resource CustomerAccountEntity for given parameters"
        }
    }
}
 

{
    "statusCode": "Error",
    "error": {
        "name": "OperationError",
        "code": "OperationError",
        "details": {
            "reason": "TransferToSameAccountNotAllowed",
            "message": "You should use different accounts"
        }
    }
}


{
    "statusCode": "Error",
    "error": {
        "name": "OperationError",
        "code": "OperationError",
        "details": {
            "reason": "CustomerAccountInsufficientFunds",
            "message": "Customer Account has no funds to cover the transaction"
        }
    }
}

Updated 3 months ago